Arvados

h1. API server

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

Resources:

* Install: "install the API server":http://doc.arvados.org/install/install-api-server.html and "create standard objects":http://doc.arvados.org/install/create-standard-objects.html

* Run test suite: see below

* [[Hacking API server]]

h2. Prerequisites

Dependencies are documented at http://doc.arvados.org/install/install-api-server.html.

h2. Test suite

Summary:

<pre>

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

</pre>

h2. Generating a self-signed certificate

Useful for dev/test environments.

<pre>

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

</pre>