~$ sudo apt-get install bison build-essential libcurl4-openssl-dev git nginx arvados-api-server
+~$ sudo apt-get install bison build-essential libcurl4-openssl-dev git arvados-api-server
~$ sudo yum install bison make automake gcc gcc-c++ libcurl-devel nginx git arvados-api-server
+~$ sudo yum install bison make automake gcc gcc-c++ libcurl-devel git arvados-api-server
~$ ruby -e 'puts rand(2**128).to_s(36)'
-6gqa1vu492idd7yca9tfandj3
-~$ sudo -u postgres createuser --encrypted -R -S --pwprompt arvados
-[sudo] password for you: yourpassword
-Enter password for new role: paste-password-you-generated
-Enter it again: paste-password-again
-~$ sudo -u postgres createdb arvados_production -T template0 -E UTF8 -O arvados
-Clusters:
+ zzzzz:
+ ...~$ sudo mkdir -p /etc/arvados/api
-~$ sudo chmod 700 /etc/arvados/api
-~$ cd /var/www/arvados-api/current
-/var/www/arvados-api/current$ sudo cp config/database.yml.sample /etc/arvados/api/database.yml
-/var/www/arvados-api/current$ sudo cp config/application.yml.example /etc/arvados/api/application.yml
-Clusters:
+ zzzzz:
+ PostgreSQL:
+ Connection:
+ host: localhost
+ user: arvados
+ password: xxxxxxxx
+ dbname: arvados_production
+ ~$ ruby -e 'puts rand(2**400).to_s(36)'
+yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
+Clusters:
+ zzzzz:
+ API:
+ RailsSessionSecretToken: yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy~$ ruby -e 'puts rand(2**400).to_s(36)'
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+~$ sudo mkdir -p /var/lib/arvados/git
-~$ sudo git clone --bare git://git.curoverse.com/arvados.git /var/lib/arvados/git/arvados.git
-Clusters:
+ zzzzz:
+ Collections:
+ BlobSigningKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx~$ ruby -e 'puts rand(2**400).to_s(36)'
-zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
-Clusters:
+ zzzzz:
+ Services:
+ SSO:
+ ExternalURL: https://sso.example.com
+ Login:
+ ProviderAppID: arvados-server
+ ProviderAppSecret: wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwClusters:
+ zzzzz:
+ Services:
+ Workbench1:
+ ExternalURL: https://workbench.zzzzz.example.com sso_app_id: arvados-server
- sso_app_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- sso_provider_url: https://sso.example.com
-Clusters:
+ zzzzz:
+ Services:
+ Websocket:
+ ExternalURL: wss://ws.zzzzz.example.com~$ sudo mkdir -p /var/lib/arvados/git/repositories
+ERROR: must be owner of extension plpgsqlClusters:
+ zzzzz:
+ Git:
+ Repositories: /var/lib/arvados/git/repositoriesClusters:
+ zzzzz:
+ Containers:
+ JobsAPI:
+ Enable: 'auto'Puma is already included with the API server's gems. We recommend you use a tool like runit or something similar. Here's a sample run script for that:
+Only required if the legacy "Jobs API" is enabled, otherwise you should skip this. -#!/bin/bash
+The @Containers.JobsAPI.GitInternalDir@ setting specifies the location of Arvados' internal git repository. By default this is @/var/lib/arvados/internal.git@. This repository stores git commits that have been used to run Crunch jobs. It should _not_ be a subdirectory of the directory in @Git.Repositories@.
-set -e
-exec 2>&1
+Example @config.yml@:
-# Uncomment the line below if you're using RVM.
-#source /etc/profile.d/rvm.sh
+
+Clusters:
+ zzzzz:
+ Containers:
+ JobsAPI:
+ GitInternalDir: /var/lib/arvados/internal.git
+
-envdir="`pwd`/env"
-mkdir -p "$envdir"
-echo ws-only > "$envdir/ARVADOS_WEBSOCKETS"
+h2(#set_up). Set up Nginx and Passenger
-cd /var/www/arvados-api/current
-echo "Starting puma in `pwd`"
+The Nginx server will serve API requests using Passenger. It will also be used to proxy SSL requests to other services which are covered later in this guide.
-# You may need to change arguments below to match your deployment, especially -u.
-exec chpst -m 1073741824 -u www-data:www-data -e "$envdir" \
- bundle exec puma -t 0:512 -e production -b tcp://127.0.0.1:8100
-Edit the http section of your Nginx configuration to run the Passenger server, and act as a front-end for both it and Puma. You might add a block like the following, adding SSL and logging parameters to taste:
+Edit the http section of your Nginx configuration to run the Passenger server. Add a block like the following, adding SSL and logging parameters to taste: -server {
+
+
+server {
listen 127.0.0.1:8000;
server_name localhost-api;
@@ -198,62 +223,55 @@ exec chpst -m 1073741824 -u www-data:www-data -e "$envdir" \
passenger_enabled on;
# If you're using RVM, uncomment the line below.
#passenger_ruby /usr/local/rvm/wrappers/default/ruby;
+
+ # This value effectively limits the size of API objects users can
+ # create, especially collections. If you change this, you should
+ # also ensure the following settings match it:
+ # * `client_max_body_size` in the server section below
+ # * `client_max_body_size` in the Workbench Nginx configuration (twice)
+ # * `API.MaxRequestSize` in config.yml
+ client_max_body_size 128m;
}
upstream api {
server 127.0.0.1:8000 fail_timeout=10s;
}
-upstream websockets {
- # The address below must match the one specified in puma's -b option.
- server 127.0.0.1:8100 fail_timeout=10s;
-}
-
proxy_http_version 1.1;
-server {
- listen [your public IP address]:443 ssl;
- server_name uuid_prefix.your.domain;
-
- ssl on;
-
- index index.html index.htm index.php;
+# When Keep clients request a list of Keep services from the API server, the
+# server will automatically return the list of available proxies if
+# the request headers include X-External-Client: 1. Following the example
+# here, at the end of this section, add a line for each netmask that has
+# direct access to Keep storage daemons to set this header value to 0.
+geo $external_client {
+ default 1;
+ 10.20.30.0/24 0;
+}
+
+
- location / {
- proxy_pass http://api;
- proxy_redirect off;
+Restart Nginx to apply the new configuration.
- proxy_set_header X-Forwarded-Proto https;
- proxy_set_header Host $http_host;
- proxy_set_header X-External-Client $external_client;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- }
-}
+
+~$ sudo nginx -s reload
+
+
-server {
- listen [your public IP address]:443 ssl;
- server_name ws.uuid_prefix.your.domain;
+h2. Prepare the API server deployment
- ssl on;
+{% assign railspkg = "arvados-api-server" %}
+{% include 'install_rails_reconfigure' %}
- index index.html index.htm index.php;
+{% include 'notebox_begin' %}
+You can safely ignore the following messages if they appear while this command runs:
- location / {
- proxy_pass http://websockets;
- proxy_redirect off;
+Don't run Bundler as root. Bundler can ask for sudo if it is needed, and installing your bundle as root will
+break this application for all non-root users on this machine.
fatal: Not a git repository (or any of the parent directories): .git