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

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install API server and Controller
   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 # "Introduction":#introduction
  13 # "Install dependencies":#dependencies
  14 # "Set up database":#database-setup
  15 # "Update config.yml":#update-config
  16 # "Update nginx configuration":#update-nginx
  17 # "Install arvados-api-server and arvados-controller":#install-packages
  18 # "Confirm working installation":#confirm-working
  19
  20 h2(#introduction). Introduction
  21
  22 The Arvados core API server consists of four services: PostgreSQL, Arvados Rails API, Arvados Controller, and Nginx.
  23
  24 Here is a simplified diagram showing the relationship between the core services.  Client requests arrive at the public-facing Nginx reverse proxy.  The request is forwarded to Arvados controller.  The controller is able handle some requests itself, the rest are forwarded to the Arvados Rails API.  The Rails API server implements the majority of business logic, communicating with the PostgreSQL database to fetch data and make transactional updates.  All services are stateless, except the PostgreSQL database.  This guide assumes all of these services will be installed on the same node, but it is possible to install these services across multiple nodes.
  25
  26 !(full-width){{site.baseurl}}/images/proxy-chain.svg!
  27
  28 h2(#dependencies). Install dependencies
  29
  30 # "Install PostgreSQL":install-postgresql.html
  31 # "Install Ruby and Bundler":ruby.html
  32 # "Install nginx":nginx.html
  33 # "Install Phusion Passenger":https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_passenger_main.html
  34
  35 h2(#database-setup). Set up database
  36
  37 {% assign service_role = "arvados" %}
  38 {% assign service_database = "arvados_production" %}
  39 {% assign use_contrib = true %}
  40 {% include 'install_postgres_database' %}
  41
  42 h2(#update-config). Update config.yml
  43
  44 Starting from an "empty config.yml file,":config.html#empty add the following configuration keys.
  45
  46 h3. Tokens
  47
  48 <notextile>
  49 <pre><code>    SystemRootToken: <span class="userinput">"$system_root_token"</span>
  50     ManagementToken: <span class="userinput">"$management_token"</span>
  51     API:
  52       RailsSessionSecretToken: <span class="userinput">"$rails_secret_token"</span>
  53     Collections:
  54       BlobSigningKey: <span class="userinput">"$blob_signing_key"</span>
  55 </code></pre>
  56 </notextile>
  57
  58 These secret tokens are used to authenticate messages between Arvados components.
  59 * @SystemRootToken@ is used by Arvados system services to authenticate as the system (root) user when communicating with the API server.
  60 * @ManagementToken@ is used to authenticate access to system metrics.
  61 * @API.RailsSessionSecretToken@ is used to sign session cookies.
  62 * @Collections.BlobSigningKey@ is used to control access to Keep blocks.
  63
  64 Each token should be a string of at least 50 alphanumeric characters. You can generate a suitable token with the following command:
  65
  66 <notextile>
  67 <pre><code>~$ <span class="userinput">tr -dc 0-9a-zA-Z &lt;/dev/urandom | head -c50 ; echo</span>
  68 </code></pre>
  69 </notextile>
  70
  71 h3. PostgreSQL.Connection
  72
  73 <notextile>
  74 <pre><code>    PostgreSQL:
  75       Connection:
  76         host: <span class="userinput">localhost</span>
  77         user: <span class="userinput">arvados</span>
  78         password: <span class="userinput">$postgres_password</span>
  79         dbname: <span class="userinput">arvados_production</span>
  80 </code></pre>
  81 </notextile>
  82
  83 Replace the @$postgres_password@ placeholder with the password you generated during "database setup":#database-setup .
  84
  85 h3. Services
  86
  87 <notextile>
  88 <pre><code>    Services:
  89       Controller:
  90         ExternalURL: <span class="userinput">"https://ClusterID.example.com"</span>
  91         InternalURLs:
  92           <span class="userinput">"http://localhost:8003": {}</span>
  93       RailsAPI:
  94         # Does not have an ExternalURL
  95         InternalURLs:
  96           <span class="userinput">"http://localhost:8004": {}</span>
  97 </code></pre>
  98 </notextile>
  99
 100 Replace @ClusterID.example.com@ with the hostname that you previously selected for the API server.
 101
 102 The @Services@ section of the configuration helps Arvados components contact one another (service discovery).  Each service has one or more @InternalURLs@ and an @ExternalURL@.  The @InternalURLs@ describe where the service runs, and how the Nginx reverse proxy will connect to it.  The @ExternalURL@ is how external clients contact the service.
 103
 104 h2(#update-nginx). Update nginx configuration
 105
 106 Use a text editor to create a new file @/etc/nginx/conf.d/arvados-api-and-controller.conf@ with the following configuration.  Options that need attention are marked in <span class="userinput">red</span>.
 107
 108 <notextile>
 109 <pre><code>proxy_http_version 1.1;
 110
 111 # When Keep clients request a list of Keep services from the API
 112 # server, use the origin IP address to determine if the request came
 113 # from the internal subnet or it is an external client.  This sets the
 114 # $external_client variable which in turn is used to set the
 115 # X-External-Client header.
 116 #
 117 # The API server uses this header to choose whether to respond to a
 118 # "available keep services" request with either a list of internal keep
 119 # servers (0) or with the keepproxy (1).
 120 #
 121 # <span class="userinput">Following the example here, update the 10.20.30.0/24 netmask</span>
 122 # <span class="userinput">to match your private subnet.</span>
 123 # <span class="userinput">Update 1.2.3.4 and add lines as necessary with the public IP</span>
 124 # <span class="userinput">address of all servers that can also access the private network to</span>
 125 # <span class="userinput">ensure they are not considered 'external'.</span>
 126
 127 geo $external_client {
 128   default        1;
 129   127.0.0.0/24   0;
 130   <span class="userinput">10.20.30.0/24</span>  0;
 131   <span class="userinput">1.2.3.4/32</span>     0;
 132 }
 133
 134 # This is the port where nginx expects to contact arvados-controller.
 135 upstream controller {
 136   server     localhost:8003  fail_timeout=10s;
 137 }
 138
 139 server {
 140   # This configures the public https port that clients will actually connect to,
 141   # the request is reverse proxied to the upstream 'controller'
 142
 143   listen       443 ssl;
 144   server_name  <span class="userinput">ClusterID.example.com</span>;
 145
 146   ssl_certificate     <span class="userinput">/YOUR/PATH/TO/cert.pem</span>;
 147   ssl_certificate_key <span class="userinput">/YOUR/PATH/TO/cert.key</span>;
 148
 149   # Refer to the comment about this setting in the passenger (arvados
 150   # api server) section of your Nginx configuration.
 151   client_max_body_size 128m;
 152
 153   location / {
 154     proxy_pass            http://controller;
 155     proxy_redirect        off;
 156     proxy_connect_timeout 90s;
 157     proxy_read_timeout    300s;
 158
 159     proxy_set_header      X-Forwarded-Proto https;
 160     proxy_set_header      Host $http_host;
 161     proxy_set_header      X-External-Client $external_client;
 162     proxy_set_header      X-Real-IP $remote_addr;
 163     proxy_set_header      X-Forwarded-For $proxy_add_x_forwarded_for;
 164   }
 165 }
 166
 167 server {
 168   # This configures the Arvados API server.  It is written using Ruby
 169   # on Rails and uses the Passenger application server.
 170
 171   listen <span class="userinput">localhost:8004</span>;
 172   server_name localhost-api;
 173
 174   root /var/www/arvados-api/current/public;
 175   index  index.html index.htm index.php;
 176
 177   passenger_enabled on;
 178
 179   # <span class="userinput">If you are using RVM, uncomment the line below.</span>
 180   # <span class="userinput">If you're using system ruby, leave it commented out.</span>
 181   #passenger_ruby /usr/local/rvm/wrappers/default/ruby;
 182
 183   # This value effectively limits the size of API objects users can
 184   # create, especially collections.  If you change this, you should
 185   # also ensure the following settings match it:
 186   # * `client_max_body_size` in the previous server section
 187   # * `API.MaxRequestSize` in config.yml
 188   client_max_body_size 128m;
 189 }
 190 </code></pre>
 191 </notextile>
 192
 193 {% assign arvados_component = 'arvados-api-server arvados-controller' %}
 194
 195 {% include 'install_packages' %}
 196
 197 {% assign arvados_component = 'arvados-controller' %}
 198
 199 {% include 'start_service' %}
 200
 201 h2(#confirm-working). Confirm working installation
 202
 203 Confirm working controller:
 204
 205 <notextile><pre><code>$ curl https://<span class="userinput">ClusterID.example.com</span>/arvados/v1/config
 206 </code></pre></notextile>
 207
 208 Confirm working Rails API server:
 209
 210 <notextile><pre><code>$ curl https://<span class="userinput">ClusterID.example.com</span>/discovery/v1/apis/arvados/v1/rest
 211 </code></pre></notextile>
 212
 213 Confirm that you can use the system root token to act as the system root user:
 214
 215 <notextile><pre><code>
 216 $ curl -H "Authorization: Bearer $system_root_token" https://<span class="userinput">ClusterID.example.com</span>/arvados/v1/users/current
 217 </code></pre></notextile>
 218
 219 h3. Troubleshooting
 220
 221 If you are getting TLS errors, make sure the @ssl_certificate@ directive in your nginx configuration has the "full certificate chain":http://nginx.org/en/docs/http/configuring_https_servers.html#chains
 222
 223 Logs can be found in @/var/www/arvados-api/current/log/production.log@ and using @journalctl -u arvados-controller@.
 224
 225 See also the admin page on "Logging":{{site.baseurl}}/admin/logging.html .