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 @SystemRootToken@ is used by Arvados system services to authenticate as the system (root) user when communicating with the API server.
  59
  60 @ManagementToken@ is used to authenticate access to system metrics.
  61
  62 @API.RailsSessionSecretToken@ is required by the API server.
  63
  64 @Collections.BlobSigningKey@ is used to control access to Keep blocks.
  65
  66 You can generate a random token for each of these items at the command line like this:
  67
  68 <notextile>
  69 <pre><code>~$ <span class="userinput">tr -dc 0-9a-zA-Z &lt;/dev/urandom | head -c50; echo</span>
  70 </code></pre>
  71 </notextile>
  72
  73 h3. PostgreSQL.Connection
  74
  75 <notextile>
  76 <pre><code>    PostgreSQL:
  77       Connection:
  78         host: <span class="userinput">localhost</span>
  79         user: <span class="userinput">arvados</span>
  80         password: <span class="userinput">$postgres_password</span>
  81         dbname: <span class="userinput">arvados_production</span>
  82 </code></pre>
  83 </notextile>
  84
  85 Replace the @$postgres_password@ placeholder with the password you generated during "database setup":#database-setup .
  86
  87 h3. Services
  88
  89 <notextile>
  90 <pre><code>    Services:
  91       Controller:
  92         ExternalURL: <span class="userinput">"https://xxxxx.example.com"</span>
  93         InternalURLs:
  94           <span class="userinput">"http://xxxxx.example.com:8003": {}</span>
  95       RailsAPI:
  96         # Does not have an ExternalURL
  97         InternalURLs:
  98           <span class="userinput">"http://xxxxx.example.com:8004": {}</span>
  99 </code></pre>
 100 </notextile>
 101
 102 Replace @xxxxx.example.com@ with the hostname that you previously selected for the API server.
 103
 104 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.
 105
 106 h2(#update-nginx). Update nginx configuration
 107
 108 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 with "TODO".
 109
 110 <notextile>
 111 <pre><code>proxy_http_version 1.1;
 112
 113 # When Keep clients request a list of Keep services from the API
 114 # server, use the origin IP address to determine if the request came
 115 # from the internal subnet or it is an external client.  This sets the
 116 # $external_client variable which in turn is used to set the
 117 # X-External-Client header.
 118 #
 119 # The API server uses this header to choose whether to respond to a
 120 # "available keep services" request with either a list of internal keep
 121 # servers (0) or with the keepproxy (1).
 122 #
 123 # TODO: Following the example here, update the netmask to the
 124 # your internal subnet.
 125
 126 geo $external_client {
 127   default        1;
 128   <span class="userinput">10.20.30.0/24</span>  0;
 129 }
 130
 131 # This is the port where nginx expects to contact arvados-controller.
 132 upstream controller {
 133   server     xxxxx.example.com:8003  fail_timeout=10s;
 134 }
 135
 136 server {
 137   # This configures the public https port that clients will actually connect to,
 138   # the request is reverse proxied to the upstream 'controller'
 139
 140   listen       <span class="userinput">xxxxx.example.com</span>:443 ssl;
 141   server_name  <span class="userinput">xxxxx.example.com</span>;
 142
 143   ssl on;
 144   ssl_certificate     <span class="userinput">/TODO/YOUR/PATH/TO/cert.pem</span>;
 145   ssl_certificate_key <span class="userinput">/TODO/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">xxxxx.example.com: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   # TODO: If you are using RVM, uncomment the line below.
 178   # If you're using system ruby, leave it commented out.
 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 {% include 'start_service' %}
 196
 197 h2(#confirm-working). Confirm working installation
 198
 199 Confirm working controller:
 200
 201 <pre>
 202 $ curl https://ClusterID.example.com/arvados/v1/config
 203 </pre>
 204
 205 Confirm working Rails API server:
 206
 207 <pre>
 208 $ curl https://ClusterID.example.com/discovery/v1/apis/arvados/v1/rest
 209 </pre>
 210
 211 Confirm that you can use the system root token to act as the system root user:
 212
 213 <pre>
 214 $ curl -H "Authorization: Bearer $system_root_token" https://xxxxx.example.com/arvados/v1/users/current
 215 </pre>
 216
 217 h3. Troubleshooting
 218
 219 See the admin page on "Logging":{{site.baseurl}}/admin/logging.html .