API server¶

This is a reference page for the API server component, colloquially "apiserver", aimed at developers.

• Install: install the API server and create standard objects
• Run test suite: see below
• Hacking API server

Prerequisites¶

Postgres

sudo apt-get install postgresql
sudo -u postgres createuser --createdb --encrypted --pwprompt arvados

Ruby

sudo apt-get install zlib1g-dev gettext bison libssl-dev libreadline-dev wget

mkdir -p /usr/local/src
cd /usr/local/src
wget http://cache.ruby-lang.org/pub/ruby/2.1/ruby-2.1.1.tar.gz
tar xzf ruby-2.1.1.tar.gz
cd ruby-2.1.1
./configure
make
sudo make install

gem install bundler

Other

sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev

Test suite¶

Summary:

git clone https://github.com/curoverse/arvados.git
cd arvados/services/api
cp -i config/application.yml.example config/application.yml
edit config/application.yml
edit config/database.yml
bundle install
bundle exec rake test

Generating a self-signed certificate¶

Useful for dev/test environments.

openssl req -new -x509 -nodes -out ./self-signed.pem -keyout ./self-signed.key -days 3650 -subj '/CN=arvados.example.com'