doc/install/install-api-server.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install the API server
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 h2. Install prerequisites
  13
  14 The Arvados package repository includes an API server package that can help automate much of the deployment.
  15
  16 h3(#install_ruby_and_bundler). Install Ruby and Bundler
  17
  18 {% include 'install_ruby_and_bundler' %}
  19
  20 h2(#install_apiserver). Install API server and dependencies
  21
  22 On a Debian-based system, install the following packages:
  23
  24 <notextile>
  25 <pre><code>~$ <span class="userinput">sudo apt-get install bison build-essential libcurl4-openssl-dev git arvados-api-server</span>
  26 </code></pre>
  27 </notextile>
  28
  29 On a Red Hat-based system, install the following packages:
  30
  31 <notextile>
  32 <pre><code>~$ <span class="userinput">sudo yum install bison make automake gcc gcc-c++ libcurl-devel git arvados-api-server</span>
  33 </code></pre>
  34 </notextile>
  35
  36 {% include 'install_git' %}
  37
  38 h2(#configure_application). Configure the API server
  39
  40 Edit @/etc/arvados/config.yml@ to set the keys below.  Only the most important configuration options are listed here.  The example configuration fragments given below should be merged into a single configuration structure.  Correct indentation is important.  The full set of configuration options are listed in "config.yml":{{site.baseurl}}/admin/config.html
  41
  42 h3(#uuid_prefix). ClusterID
  43
  44 The @ClusterID@ is used for all database identifiers to identify the record as originating from this site.  It is the first key under @Clusters@ in @config.yml@.  It must be exactly 5 lowercase ASCII letters and digits.  All configuration items go under the cluster id key (replace @zzzzz@ with your cluster id in the examples below).
  45
  46 <notextile>
  47 <pre><code>Clusters:
  48   <span class="userinput">zzzzz</span>:
  49     ...</code></pre>
  50 </notextile>
  51
  52 h3(#configure). PostgreSQL.Connection
  53
  54 Replace the @xxxxxxxx@ database password placeholder with the "password you generated during database setup":install-postgresql.html#api.
  55
  56 <notextile>
  57 <pre><code>Clusters:
  58   zzzzz:
  59     PostgreSQL:
  60       Connection:
  61         host: <span class="userinput">localhost</span>
  62         user: <span class="userinput">arvados</span>
  63         password: <span class="userinput">xxxxxxxx</span>
  64         dbname: <span class="userinput">arvados_production</span>
  65       </code></pre>
  66 </notextile>
  67
  68 h3. API.RailsSessionSecretToken
  69
  70 The @API.RailsSessionSecretToken@ is used for for signing cookies.  IMPORTANT: This is a site secret. It should be at least 50 characters.  Generate a random value and set it in @config.yml@:
  71
  72 <notextile>
  73 <pre><code>~$ <span class="userinput">ruby -e 'puts rand(2**400).to_s(36)'</span>
  74 yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
  75 </code></pre></notextile>
  76
  77 Example @config.yml@:
  78
  79 <notextile>
  80 <pre><code>Clusters:
  81   zzzzz:
  82     API:
  83       RailsSessionSecretToken: <span class="userinput">yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy</span></code></pre>
  84 </notextile>
  85
  86 h3(#blob_signing_key). Collections.BlobSigningKey
  87
  88 The @Collections.BlobSigningKey@ is used to enforce access control to Keep blocks.  This same key must be provided to the Keepstore daemons when "installing Keepstore servers.":install-keepstore.html  IMPORTANT: This is a site secret. It should be at least 50 characters.  Generate a random value and set it in @config.yml@:
  89
  90 <notextile>
  91 <pre><code>~$ <span class="userinput">ruby -e 'puts rand(2**400).to_s(36)'</span>
  92 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  93 </code></pre></notextile>
  94
  95 Example @config.yml@:
  96
  97 <notextile>
  98 <pre><code>Clusters:
  99   zzzzz:
 100     Collections:
 101       BlobSigningKey: <span class="userinput">xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</span></code></pre>
 102 </notextile>
 103
 104 h3(#omniauth). Login.ProviderAppID, Login.ProviderAppSecret, Services.SSO.ExternalURL
 105
 106 The following settings enable the API server to communicate with the "Single Sign On (SSO) server":install-sso.html to authenticate user log in.
 107
 108 Set @Services.SSO.ExternalURL@ to the base URL where your SSO server is installed.  This should be a URL consisting of the scheme and host (and optionally, port), without a trailing slash.
 109
 110 Set @Login.ProviderAppID@ and @Login.ProviderAppSecret@ to the corresponding values for @app_id@ and @app_secret@ used in the "Create arvados-server client for Single Sign On (SSO)":install-sso.html#client step.
 111
 112 Example @config.yml@:
 113
 114 <notextile>
 115 <pre><code>Clusters:
 116   zzzzz:
 117     Services:
 118       SSO:
 119         ExternalURL: <span class="userinput">https://sso.example.com</span>
 120     Login:
 121       ProviderAppID: <span class="userinput">arvados-server</span>
 122       ProviderAppSecret: <span class="userinput">wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww</span></code></pre>
 123 </notextile>
 124
 125 h3. Services.Workbench1.ExternalURL
 126
 127 Set @Services.Workbench1.ExternalURL@ to the URL of your workbench application after following "Install Workbench.":install-workbench-app.html
 128
 129 Example @config.yml@:
 130
 131 <notextile>
 132 <pre><code>Clusters:
 133   zzzzz:
 134     Services:
 135       Workbench1:
 136         ExternalURL: <span class="userinput">https://workbench.zzzzz.example.com</span></code></pre>
 137 </notextile>
 138
 139 h3. Services.Websocket.ExternalURL
 140
 141 Set @Services.Websocket.ExternalURL@ to the @wss://@ URL of the API server websocket endpoint after following "Install the websocket server":install-ws.html .
 142
 143 Example @config.yml@:
 144
 145 <notextile>
 146 <pre><code>Clusters:
 147   zzzzz:
 148     Services:
 149       Websocket:
 150         ExternalURL: <span class="userinput">wss://ws.zzzzz.example.com</span></code></pre>
 151 </notextile>
 152
 153 h3(#git_repositories_dir). Git.Repositories
 154
 155 The @Git.Repositories@ setting specifies the directory where user git repositories will be stored.
 156
 157 The git server setup process is covered on "its own page":install-arv-git-httpd.html. For now, create an empty directory in the default location:
 158
 159 <notextile>
 160 <pre><code>~$ <span class="userinput">sudo mkdir -p /var/lib/arvados/git/repositories</span>
 161 </code></pre></notextile>
 162
 163 If you intend to store your git repositories in a different location, specify that location in @config.yml@.  Example:
 164
 165 <notextile>
 166 <pre><code>Clusters:
 167   zzzzz:
 168     Git:
 169       Repositories: <span class="userinput">/var/lib/arvados/git/repositories</span></code></pre>
 170 </notextile>
 171
 172 h3(#enable_legacy_jobs_api). Containers.JobsAPI.Enable
 173
 174 Enable the legacy "Jobs API":install-crunch-dispatch.html .  Note: new installations should use the "Containers API":crunch2-slurm/install-prerequisites.html
 175
 176 Disabling the jobs API means methods involving @jobs@, @job_tasks@, @pipeline_templates@ and @pipeline_instances@ are disabled.  This functionality is superceded by the containers API which consists of @container_requests@, @containers@ and @workflows@.  Arvados clients (such as @arvados-cwl-runner@) detect which APIs are available and adjust behavior accordingly.  Note the configuration value must be a quoted string.
 177
 178 * 'auto' -- (default) enable the Jobs API only if it has been used before (i.e., there are job records in the database), otherwise disable jobs API .
 179 * 'true' -- enable the Jobs API even if there are no existing job records.
 180 * 'false' -- disable the Jobs API even in the presence of existing job records.
 181
 182 <notextile>
 183 <pre><code>Clusters:
 184   zzzzz:
 185     Containers:
 186       JobsAPI:
 187         Enable: <span class="userinput">'auto'</span></code></pre>
 188 </notextile>
 189
 190 h4(#git_internal_dir). Containers.JobsAPI.GitInternalDir
 191
 192 Only required if the legacy "Jobs API" is enabled, otherwise you should skip this.
 193
 194 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@.
 195
 196 Example @config.yml@:
 197
 198 <notextile>
 199 <pre><code>Clusters:
 200   zzzzz:
 201     Containers:
 202       JobsAPI:
 203         GitInternalDir: <span class="userinput">/var/lib/arvados/internal.git</span></code></pre>
 204 </notextile>
 205
 206 h2(#set_up). Set up Nginx and Passenger
 207
 208 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.
 209
 210 First, "Install Nginx and Phusion Passenger":https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_passenger_main.html.
 211
 212 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:
 213
 214 <notextile>
 215 <pre><code>
 216 server {
 217   listen 127.0.0.1:8000;
 218   server_name localhost-api;
 219
 220   root /var/www/arvados-api/current/public;
 221   index  index.html index.htm index.php;
 222
 223   passenger_enabled on;
 224   # If you're using RVM, uncomment the line below.
 225   #passenger_ruby /usr/local/rvm/wrappers/default/ruby;
 226
 227   # This value effectively limits the size of API objects users can
 228   # create, especially collections.  If you change this, you should
 229   # also ensure the following settings match it:
 230   # * `client_max_body_size` in the server section below
 231   # * `client_max_body_size` in the Workbench Nginx configuration (twice)
 232   # * `API.MaxRequestSize` in config.yml
 233   client_max_body_size 128m;
 234 }
 235
 236 upstream api {
 237   server     127.0.0.1:8000  fail_timeout=10s;
 238 }
 239
 240 proxy_http_version 1.1;
 241
 242 # When Keep clients request a list of Keep services from the API server, the
 243 # server will automatically return the list of available proxies if
 244 # the request headers include X-External-Client: 1.  Following the example
 245 # here, at the end of this section, add a line for each netmask that has
 246 # direct access to Keep storage daemons to set this header value to 0.
 247 geo $external_client {
 248   default        1;
 249   <span class="userinput">10.20.30.0/24</span>  0;
 250 }
 251 </code></pre>
 252 </notextile>
 253
 254 Restart Nginx to apply the new configuration.
 255
 256 <notextile>
 257 <pre><code>~$ <span class="userinput">sudo nginx -s reload</span>
 258 </code></pre>
 259 </notextile>
 260
 261 h2. Prepare the API server deployment
 262
 263 {% assign railspkg = "arvados-api-server" %}
 264 {% include 'install_rails_reconfigure' %}
 265
 266 {% include 'notebox_begin' %}
 267 You can safely ignore the following messages if they appear while this command runs:
 268
 269 <notextile><pre>Don't run Bundler as root. Bundler can ask for sudo if it is needed, and installing your bundle as root will
 270 break this application for all non-root users on this machine.</pre></notextile>
 271
 272 <notextile><pre>fatal: Not a git repository (or any of the parent directories): .git</pre></notextile>
 273 {% include 'notebox_end' %}
 274
 275 h2. Troubleshooting
 276
 277 Once you have the API Server up and running you may need to check it back if dealing with client related issues. Please read our "admin troubleshooting notes":{{site.baseurl}}/admin/troubleshooting.html on how requests can be tracked down between services.