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     Collections:
  52       BlobSigningKey: <span class="userinput">"blob_signing_key"</span>
  53 </code></pre>
  54 </notextile>
  55
  56 @SystemRootToken@ is used by Arvados system services to authenticate as the system (root) user when communicating with the API server.
  57
  58 @ManagementToken@ is used to authenticate access to system metrics.
  59
  60 @Collections.BlobSigningKey@ is used to control access to Keep blocks.
  61
  62 You can generate a random token for each of these items at the command line like this:
  63
  64 <notextile>
  65 <pre><code>~$ <span class="userinput">tr -dc 0-9a-zA-Z &lt;/dev/urandom | head -c50; echo</span>
  66 </code></pre>
  67 </notextile>
  68
  69 h3. PostgreSQL.Connection
  70
  71 <notextile>
  72 <pre><code>    PostgreSQL:
  73       Connection:
  74         host: <span class="userinput">localhost</span>
  75         user: <span class="userinput">arvados</span>
  76         password: <span class="userinput">$postgres_password</span>
  77         dbname: <span class="userinput">arvados_production</span>
  78 </code></pre>
  79 </notextile>
  80
  81 Replace the @$postgres_password@ placeholder with the password you generated during "database setup":#database-setup .
  82
  83 h3. Services
  84
  85 <notextile>
  86 <pre><code>    Services:
  87       Controller:
  88         ExternalURL: <span class="userinput">"https://ClusterID.example.com"</span>
  89         InternalURLs:
  90           <span class="userinput">"http://localhost:8003": {}</span>
  91       RailsAPI:
  92         # Does not have an ExternalURL
  93         InternalURLs:
  94           <span class="userinput">"http://localhost:8004": {}</span>
  95 </code></pre>
  96 </notextile>
  97
  98 Replace @ClusterID.example.com@ with the hostname that you previously selected for the API server.
  99
 100 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.
 101
 102 h2(#update-nginx). Update nginx configuration
 103
 104 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>.
 105
 106 <notextile>
 107 <pre><code>proxy_http_version 1.1;
 108
 109 # When Keep clients request a list of Keep services from the API
 110 # server, use the origin IP address to determine if the request came
 111 # from the internal subnet or it is an external client.  This sets the
 112 # $external_client variable which in turn is used to set the
 113 # X-External-Client header.
 114 #
 115 # The API server uses this header to choose whether to respond to a
 116 # "available keep services" request with either a list of internal keep
 117 # servers (0) or with the keepproxy (1).
 118 #
 119 # <span class="userinput">Following the example here, update the 10.20.30.0/24 netmask</span>
 120 # <span class="userinput">to match your private subnet.</span>
 121 # <span class="userinput">Update 1.2.3.4 and add lines as necessary with the public IP</span>
 122 # <span class="userinput">address of all servers that can also access the private network to</span>
 123 # <span class="userinput">ensure they are not considered 'external'.</span>
 124
 125 geo $external_client {
 126   default        1;
 127   127.0.0.0/24   0;
 128   <span class="userinput">10.20.30.0/24</span>  0;
 129   <span class="userinput">1.2.3.4/32</span>     0;
 130 }
 131
 132 # This is the port where nginx expects to contact arvados-controller.
 133 upstream controller {
 134   server     localhost:8003  fail_timeout=10s;
 135 }
 136
 137 server {
 138   # This configures the public https port that clients will actually connect to,
 139   # the request is reverse proxied to the upstream 'controller'
 140
 141   listen       443 ssl;
 142   server_name  <span class="userinput">ClusterID.example.com</span>;
 143
 144   ssl_certificate     <span class="userinput">/YOUR/PATH/TO/cert.pem</span>;
 145   ssl_certificate_key <span class="userinput">/YOUR/PATH/TO/cert.key</span>;
 146
 147   # Refer to the comment about this setting in the passenger (arvados
 148   # api server) section of your Nginx configuration.
 149   client_max_body_size 128m;
 150
 151   location / {
 152     proxy_pass            http://controller;
 153     proxy_redirect        off;
 154     proxy_connect_timeout 90s;
 155     proxy_read_timeout    300s;
 156
 157     proxy_set_header      X-Forwarded-Proto https;
 158     proxy_set_header      Host $http_host;
 159     proxy_set_header      X-External-Client $external_client;
 160     proxy_set_header      X-Real-IP $remote_addr;
 161     proxy_set_header      X-Forwarded-For $proxy_add_x_forwarded_for;
 162   }
 163 }
 164
 165 server {
 166   # This configures the Arvados API server.  It is written using Ruby
 167   # on Rails and uses the Passenger application server.
 168
 169   listen <span class="userinput">localhost:8004</span>;
 170   server_name localhost-api;
 171
 172   root /var/www/arvados-api/current/public;
 173   index  index.html index.htm index.php;
 174
 175   passenger_enabled on;
 176
 177   # <span class="userinput">If you are using RVM, uncomment the line below.</span>
 178   # <span class="userinput">If you're using system ruby, leave it commented out.</span>
 179   #passenger_ruby /usr/local/rvm/wrappers/default/ruby;
 180
 181   # This value effectively limits the size of API objects users can
 182   # create, especially collections.  If you change this, you should
 183   # also ensure the following settings match it:
 184   # * `client_max_body_size` in the previous server section
 185   # * `API.MaxRequestSize` in config.yml
 186   client_max_body_size 128m;
 187 }
 188 </code></pre>
 189 </notextile>
 190
 191 {% assign arvados_component = 'arvados-api-server arvados-controller' %}
 192
 193 {% include 'install_packages' %}
 194
 195 {% assign arvados_component = 'arvados-controller' %}
 196
 197 {% include 'start_service' %}
 198
 199 h2(#confirm-working). Confirm working installation
 200
 201 Confirm working controller:
 202
 203 <notextile><pre><code>$ curl https://<span class="userinput">ClusterID.example.com</span>/arvados/v1/config
 204 </code></pre></notextile>
 205
 206 Confirm working Rails API server:
 207
 208 <notextile><pre><code>$ curl https://<span class="userinput">ClusterID.example.com</span>/discovery/v1/apis/arvados/v1/rest
 209 </code></pre></notextile>
 210
 211 Confirm that you can use the system root token to act as the system root user:
 212
 213 <notextile><pre><code>
 214 $ curl -H "Authorization: Bearer $system_root_token" https://<span class="userinput">ClusterID.example.com</span>/arvados/v1/users/current
 215 </code></pre></notextile>
 216
 217 h3. Troubleshooting
 218
 219 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
 220
 221 Logs can be found in @/var/www/arvados-api/current/log/production.log@ and using @journalctl -u arvados-controller@.
 222
 223 See also the admin page on "Logging":{{site.baseurl}}/admin/logging.html .