X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/51dc4f3f6d1faa0dfa79ae4d282f584fbe797299..e9dcedd8dda3de8360e34bfca536dd606d558d34:/doc/install/install-api-server.html.textile.liquid?ds=sidebyside diff --git a/doc/install/install-api-server.html.textile.liquid b/doc/install/install-api-server.html.textile.liquid index 3846e3c9aa..91e2c69892 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -12,32 +12,29 @@ h3(#install_ruby_and_bundler). Install Ruby and Bundler {% include 'install_ruby_and_bundler' %} -h3(#install_postgres). Install Postgres +h3(#install_postgres). Install PostgreSQL {% include 'install_postgres' %} -h3(#build_tools_apiserver). Build tools - -* Build tools and the curl and PostgreSQL development libraries, to build gem dependencies -* Nginx - -On older distributions, you may need to use a backports repository to satisfy these requirements. For example, on older Red Hat-based systems, consider using the "postgresql92":https://www.softwarecollections.org/en/scls/rhscl/postgresql92/ and "nginx16":https://www.softwarecollections.org/en/scls/rhscl/nginx16/ Software Collections. +h2(#install_apiserver). Install API server and dependencies On a Debian-based system, install the following packages: -
~$ sudo apt-get install bison build-essential libpq-dev libcurl4-openssl-dev postgresql git nginx arvados-api-server
+
~$ sudo apt-get install bison build-essential libcurl4-openssl-dev git arvados-api-server
 
On a Red Hat-based system, install the following packages: -
~$ sudo yum install bison make automake gcc gcc-c++ libcurl-devel postgresql-server postgresql-devel nginx git arvados-api-server
+
~$ sudo yum install bison make automake gcc gcc-c++ libcurl-devel git arvados-api-server
 
-h2. Set up the database +{% include 'install_git' %} + +h2(#configure). Set up the database Generate a new database password. Nobody ever needs to memorize it or type it, so we'll make a strong one: @@ -55,11 +52,9 @@ Enter password for new role: paste-password-you-generate Enter it again: paste-password-again
-{% include 'notebox_begin' %} - -This user setup assumes that your PostgreSQL is configured to accept password authentication. Red Hat systems use ident-based authentication by default. You may need to either adapt the user creation, or reconfigure PostgreSQL (in @pg_hba.conf@) to accept password authentication. - -{% include 'notebox_end' %} +{% assign pg_hba_path = "/opt/rh/postgresql92/root/var/lib/pgsql/data/pg_hba.conf" %} +{% assign pg_service = "postgresql92-postgresql" %} +{% include 'install_redhat_postgres_auth' %} Create the database: @@ -68,94 +63,276 @@ Create the database:
-h2. Set up configuration files - -The API server package uses configuration files that you write to @/etc/arvados/api@ and ensures they're consistently deployed. Create this directory and copy the example configuration files to it: - - -
~$ 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
-
-
- h2. Configure the database connection Edit @/etc/arvados/api/database.yml@ and replace the @xxxxxxxx@ database password placeholders with the PostgreSQL password you generated above. -h2. Configure the API server +h2(#configure_application). Configure the API server -Edit @/etc/arvados/api/application.yml@ following the instructions below. The deployment script will consistently deploy this to the API server's configuration directory. The API server reads both @application.yml@ and its own @config/application.default.yml@ file. Values in @application.yml@ take precedence over the defaults that are defined in @config/application.default.yml@. The @config/application.yml.example@ file is not read by the API server and is provided for installation convenience only. +Edit @/etc/arvados/api/application.yml@ to configure the settings described in the following sections. The API server reads both @application.yml@ and its own @config/application.default.yml@ file. The settings in @application.yml@ take precedence over the defaults that are defined in @config/application.default.yml@. The @config/application.yml.example@ file is not read by the API server and is provided as a starting template only. -Always put your local configuration in @application.yml@ instead of editing @application.default.yml@. +@config/application.default.yml@ documents additional configuration settings not listed here. You can "view the current source version":https://dev.arvados.org/projects/arvados/repository/revisions/master/entry/services/api/config/application.default.yml for reference. + +Only put local configuration in @application.yml@. Do not edit @application.default.yml@. h3(#uuid_prefix). uuid_prefix -Define your @uuid_prefix@ in @application.yml@ by setting the @uuid_prefix@ field in the section for your environment. This prefix is used for all database identifiers to identify the record as originating from this site. It must be exactly 5 alphanumeric characters (lowercase ASCII letters and digits). +Define your @uuid_prefix@ in @application.yml@ by setting the @uuid_prefix@ field in the section for your environment. This prefix is used for all database identifiers to identify the record as originating from this site. It must be exactly 5 lowercase ASCII letters and digits. -h3(#git_repositories_dir). git_repositories_dir +Example @application.yml@: -This field defaults to @/var/lib/arvados/git@. You can override the value by defining it in @application.yml@. + +
  uuid_prefix: zzzzz
+
-Make sure a clone of the arvados repository exists in @git_repositories_dir@. +h3. secret_token + +The @secret_token@ 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 @application.yml@: -
~$ sudo mkdir -p /var/lib/arvados/git
-~$ sudo git clone --bare git://git.curoverse.com/arvados.git /var/lib/arvados/git/arvados.git
+
~$ ruby -e 'puts rand(2**400).to_s(36)'
+yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
 
-h3. secret_token +Example @application.yml@: + + +
  secret_token: yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
+
+ +h3(#blob_signing_key). blob_signing_key -Generate a new secret token for signing cookies: +The @blob_signing_key@ 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 @application.yml@:
~$ ruby -e 'puts rand(2**400).to_s(36)'
-zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 
-Then put that value in the @secret_token@ field. +Example @application.yml@: + + +
  blob_signing_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+ +h3(#omniauth). sso_app_secret, sso_app_id, sso_provider_url + +The following settings enable the API server to communicate with the "Single Sign On (SSO) server":install-sso.html to authenticate user log in. -h3. blob_signing_key +Set @sso_provider_url@ 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. -If you want access control on your "Keepstore":install-keepstore.html server(s), you should set @blob_signing_key@ to the same value as the permission key you provide to your Keepstore daemon(s). +Set @sso_app_secret@ and @sso_app_id@ to the corresponding values for @app_secret@ and @app_id@ used in the "Create arvados-server client for Single Sign On (SSO)":install-sso.html#client step. + +Example @application.yml@: + + +
  sso_app_id: arvados-server
+  sso_app_secret: wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww
+  sso_provider_url: https://sso.example.com
+
+
h3. workbench_address -Fill in the url of your workbench application in @workbench_address@, for example +Set @workbench_address@ to the URL of your workbench application after following "Install Workbench.":install-workbench-app.html -  https://workbench.@uuid_prefix@.your.domain +Example @application.yml@: -h3(#omniauth). sso_app_id, sso_app_secret, sso_provider_url + +
  workbench_address: https://workbench.zzzzz.example.com
+
-For @sso_app_id@ and @sso_app_secret@, provide the same @app_id@ and @app_secret@ used in the "Create arvados-server client for Single Sign On (SSO)":install-sso.html#client step. +h3. websocket_address -For @sso_provider_url@, provide the base URL where your SSO server is installed: just the scheme and host, with no trailing slash. +Set @websocket_address@ to the @wss://@ URL of the API server websocket endpoint after following "Set up Web servers":#set_up. The path of the default endpoint is @/websocket@. + +Example @application.yml@: -
  sso_app_id: arvados-server
-  sso_app_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-  sso_provider_url: https://sso.example.com
+
  websocket_address: wss://ws.zzzzz.example.com/websocket
+ + +h3(#git_repositories_dir). git_repositories_dir + +The @git_repositories_dir@ setting specifies the directory where user git repositories will be stored. + +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: + + +
~$ sudo mkdir -p /var/lib/arvados/git/repositories
+
+ +If you intend to store your git repositories in a different location, specify that location in @application.yml@. + +Default setting in @application.default.yml@: + + +
  git_repositories_dir: /var/lib/arvados/git/repositories
 
-h3. Other options +h3(#git_internal_dir). git_internal_dir -Consult @/var/www/arvados-api/current/config/application.default.yml@ for a full list of configuration options. (But don't edit it. Edit @application.yml@ instead.) +The @git_internal_dir@ 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 @git_repositories_dir@. -h2. Prepare the API server deployment +Example @application.yml@: -Now that all your configuration is in place, run @/usr/local/bin/arvados-api-server-upgrade.sh@. This will install and check your configuration, install necessary gems, and run any necessary database setup. + +
  git_internal_dir: /var/lib/arvados/internal.git
+
+
+ +h2(#set_up). Set up Web servers + +For best performance, we recommend you use Nginx as your Web server front-end, with a Passenger backend for the main API server and a Puma backend for API server Websockets. To do that: -{% include 'notebox_begin' %} -You can safely ignore the following error message you may see when loading the database structure: -
ERROR:  must be owner of extension plpgsql
-{% include 'notebox_end' %} +
    +
  1. Install Nginx and Phusion Passenger.
  2. -This command aborts when it encounters an error. It's safe to rerun multiple times, so if there's a problem with your configuration, you can fix that and try again. +
  3. Install runit to supervise the Puma daemon. {% include 'install_runit' %}

  4. -h2. Set up Web servers +
  5. Install the script below as the run script for the Puma service, modifying it as directed by the comments.

    -{% include 'install_nginx_apiserver' %} +
    #!/bin/bash
    +
    +set -e
    +exec 2>&1
    +
    +# Uncomment the line below if you're using RVM.
    +#source /etc/profile.d/rvm.sh
    +
    +envdir="`pwd`/env"
    +mkdir -p "$envdir"
    +echo ws-only > "$envdir/ARVADOS_WEBSOCKETS"
    +
    +cd /var/www/arvados-api/current
    +echo "Starting puma in `pwd`"
    +
    +# Change arguments below to match your deployment, "webserver-user" and
    +# "webserver-group" should be changed to the user and group of the web server
    +# process.  This is typically "www-data:www-data" on Debian systems by default,
    +# other systems may use different defaults such the name of the web server
    +# software (for example, "nginx:nginx").
    +exec chpst -m 1073741824 -u webserver-user:webserver-group -e "$envdir" \
    +  bundle exec puma -t 0:512 -e production -b tcp://127.0.0.1:8100
    +
    +
  6. + +
  7. 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:

    + +
    server {
    +  listen 127.0.0.1:8000;
    +  server_name localhost-api;
    +
    +  root /var/www/arvados-api/current/public;
    +  index  index.html index.htm index.php;
    +
    +  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)
    +  # * `max_request_size` in the API server's application.yml file
    +  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;
    +
    +# 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;
    +}
    +
    +server {
    +  listen       [your public IP address]:443 ssl;
    +  server_name  uuid_prefix.your.domain;
    +
    +  ssl on;
    +  ssl_certificate     /YOUR/PATH/TO/cert.pem;
    +  ssl_certificate_key /YOUR/PATH/TO/cert.key;
    +
    +  index  index.html index.htm index.php;
    +
    +  # Refer to the comment about this setting in the server section above.
    +  client_max_body_size 128m;
    +
    +  location / {
    +    proxy_pass            http://api;
    +    proxy_redirect        off;
    +    proxy_connect_timeout 90s;
    +    proxy_read_timeout    300s;
    +
    +    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;
    +  }
    +}
    +
    +server {
    +  listen       [your public IP address]:443 ssl;
    +  server_name  ws.uuid_prefix.your.domain;
    +
    +  ssl on;
    +  ssl_certificate     /YOUR/PATH/TO/cert.pem;
    +  ssl_certificate_key /YOUR/PATH/TO/cert.key;
    +
    +  index  index.html index.htm index.php;
    +
    +  location / {
    +    proxy_pass            http://websockets;
    +    proxy_redirect        off;
    +    proxy_connect_timeout 90s;
    +    proxy_read_timeout    300s;
    +
    +    proxy_set_header      Upgrade $http_upgrade;
    +    proxy_set_header      Connection "upgrade";
    +    proxy_set_header      Host $host;
    +    proxy_set_header      X-Real-IP $remote_addr;
    +    proxy_set_header      X-Forwarded-For $proxy_add_x_forwarded_for;
    +  }
    +}
    +
    +
  8. + +
  9. Restart Nginx:

    + +
    ~$ sudo nginx -s reload
    +
    + +
  10. + +
+ + +h2. Prepare the API server deployment + +{% assign railspkg = "arvados-api-server" %} +{% include 'install_rails_reconfigure' %} + +{% include 'notebox_begin' %} +You can safely ignore the following messages if they appear while this command runs: +
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
+{% include 'notebox_end' %}