X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b6f800ae7e474f1ceeb827fc9712296a96514592..9024a5b5eb247e3a552dbb92a61f7c916c0d4349:/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 3c188e3828..464559a74c 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -32,7 +32,9 @@ On a Red Hat-based system, install the following packages: -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: @@ -50,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: @@ -84,7 +84,7 @@ h2(#configure_application). Configure the API server Edit @/etc/arvados/api/application.yml@ to configure the settings described in the following sections. 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. 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. -@config/application.default.yml@ documents additional configuration settings not listed here. You can "view the current source version":https://arvados.org/projects/arvados/repository/revisions/master/entry/services/api/config/application.default.yml for reference. +@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@. @@ -155,33 +155,34 @@ Example @application.yml@: 
  workbench_address: https://workbench.zzzzz.example.com
-h3. websockets_address +h3. websocket_address -Set @websockets_address@ to the @wss://@ URL of the API server websocket endpoint after following "Set up Web servers.":#set_up +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@: -
  websockets_address: wss://ws.zzzzz.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. By default this is @/var/lib/arvados/git@. +The @git_repositories_dir@ setting specifies the directory where user git repositories will be stored. -Example @application.yml@: +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: -
  git_repositories_dir: /var/lib/arvados/git
-
- +
~$ sudo mkdir -p /var/lib/arvados/git/repositories
+
-Make sure a clone of the arvados repository exists in @git_repositories_dir@. +If you intend to store your git repositories in a different location, specify that location in @application.yml@. + +Default setting in @application.default.yml@: -
~$ sudo mkdir -p /var/lib/arvados/git
-~$ sudo git clone --bare git://git.curoverse.com/arvados.git /var/lib/arvados/git/arvados.git
-
 +
  git_repositories_dir: /var/lib/arvados/git/repositories
+
+ h3(#git_internal_dir). git_internal_dir @@ -194,27 +195,17 @@ Example @application.yml@: -h2. Prepare the API server deployment - -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. - -{% 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' %} - -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. - 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. +
  2. Install Nginx and Phusion Passenger.
    3. + +

  3. Install runit to supervise the Puma daemon. {% include 'install_runit' %}

    4. -

  4. Puma is already included with the API server's gems. We recommend you run it as a service under runit or a similar tool. Here's a sample runit script for that:

    +

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

    #!/bin/bash
 
@@ -231,8 +222,12 @@ echo ws-only > "$envdir/ARVADOS_WEBSOCKETS"
 cd /var/www/arvados-api/current
 echo "Starting puma in `pwd`"
 
-# You may need to change arguments below to match your deployment, especially -u.
-exec chpst -m 1073741824 -u www-data:www-data -e "$envdir" \
+# 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. @@ -249,6 +244,14 @@ exec chpst -m 1073741824 -u www-data:www-data -e "$envdir" \ 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 { @@ -282,6 +285,9 @@ server { 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; @@ -322,7 +328,24 @@ server { -
  6. Restart Nginx.
    7. +

  7. Restart Nginx:

    + +
    ~$ sudo nginx -s reload
+
    + +
 + +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' %}