X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/a9335a762f70e30affdb259e2ff487f27963f1c8..727c1e475afcb1a8fda1f9b689bb3e941ae93cec:/doc/install/install-api-server.html.textile.liquid diff --git a/doc/install/install-api-server.html.textile.liquid b/doc/install/install-api-server.html.textile.liquid index 91e2c69892..fa07f889f1 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -12,10 +12,6 @@ h3(#install_ruby_and_bundler). Install Ruby and Bundler {% include 'install_ruby_and_bundler' %} -h3(#install_postgres). Install PostgreSQL - -{% include 'install_postgres' %} - h2(#install_apiserver). Install API server and dependencies On a Debian-based system, install the following packages: @@ -36,37 +32,12 @@ On a Red Hat-based system, install the following packages: 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: +Configure the API server to connect to your database by updating @/etc/arvados/api/database.yml@. Replace the @xxxxxxxx@ database password placeholder with the "password you generated during database setup":install-postgresql.html#api. Be sure to update the @production@ section. -
~$ ruby -e 'puts rand(2**128).to_s(36)'
-6gqa1vu492idd7yca9tfandj3
+
~$ editor /etc/arvados/api/database.yml
 
-Create a new database user. - - -
~$ sudo -u postgres createuser --encrypted -R -S --pwprompt arvados
-[sudo] password for you: yourpassword
-Enter password for new role: paste-password-you-generated
-Enter it again: paste-password-again
-
- -{% 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: - - -
~$ sudo -u postgres createdb arvados_production -T template0 -E UTF8 -O arvados
-
-
- -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_application). Configure the API server 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. @@ -182,45 +153,15 @@ Example @application.yml@:
-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: - - -
    -
  1. Install Nginx and Phusion Passenger.
  2. - -
  3. Install runit to supervise the Puma daemon. {% include 'install_runit' %}

  4. - -
  5. Install the script below as the run script for the Puma service, modifying it as directed by the comments.

    - -
    #!/bin/bash
    +h2(#set_up). Set up Nginx and Passenger
     
    -set -e
    -exec 2>&1
    +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.
     
    -# Uncomment the line below if you're using RVM.
    -#source /etc/profile.d/rvm.sh
    +First, "Install Nginx and Phusion Passenger":https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_passenger_main.html.
     
    -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:

    +Edit the http section of your Nginx configuration to run the Passenger server, and serve SSL requests. Add a block like the following, adding SSL and logging parameters to taste: +
    server {
       listen 127.0.0.1:8000;
       server_name localhost-api;
    @@ -245,11 +186,6 @@ 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
    @@ -288,41 +224,14 @@ server {
         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:

    +Restart Nginx to apply the new configuration. +
    ~$ sudo nginx -s reload
     
    - -
  10. - -
h2. Prepare the API server deployment @@ -332,7 +241,9 @@ h2. Prepare the API server deployment {% 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
+ +
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' %}