Project

General

Profile

API server » History » Version 5

Tom Clegg, 05/14/2014 03:05 AM

1 1 Tom Clegg
h1. API server
2
3
This is a reference page for the API server component, colloquially "apiserver", aimed at developers.
4
5
Resources:
6
* 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
7
* Run test suite: see below
8 3 Tom Clegg
* [[Hacking API server]]
9 1 Tom Clegg
10
h2. Prerequisites
11
12 4 Tom Clegg
Dependencies are documented at http://doc.arvados.org/install/install-api-server.html.
13 1 Tom Clegg
14
h2. Test suite
15
16
Summary:
17
18
<pre>
19
git clone https://github.com/curoverse/arvados.git
20
cd arvados/services/api
21
cp -i config/application.yml.example config/application.yml
22
edit config/application.yml
23
edit config/database.yml
24 5 Tom Clegg
RAILS_ENV=test bundle install
25
RAILS_ENV=test bundle exec rake test
26 1 Tom Clegg
</pre>
27 2 Tom Clegg
28
h2. Generating a self-signed certificate
29
30
Useful for dev/test environments.
31
32
<pre>
33
openssl req -new -x509 -nodes -out ./self-signed.pem -keyout ./self-signed.key -days 3650 -subj '/CN=arvados.example.com'
34
</pre>