X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/ac1c1f563b53d22629e36e7d67de028abe55f1df..40103b455d0df2bc47eaba422a72bf6ec4fd6808:/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 f2a518a244..91e2c69892 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -34,7 +34,7 @@ On a Red Hat-based system, install the following packages: {% include 'install_git' %} -h2. Set up the database +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: @@ -52,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: @@ -65,26 +63,13 @@ 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.example /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_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. +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. @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. @@ -197,28 +182,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 messages if they appear while this script 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' %} - -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. 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:

    +

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

    5. + +

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

    #!/bin/bash
 
@@ -257,6 +231,14 @@ exec chpst -m 1073741824 -u webserver-user:webserver-group -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 {
@@ -290,10 +272,7 @@ server {
 
   index  index.html index.htm index.php;
 
-  # This value effectively limits the size of API objects users can create,
-  # especially collections.  If you change this, you should also set
-  # `max_request_size` in the API server's application.yml file to the same
-  # value.
+  # Refer to the comment about this setting in the server section above.
   client_max_body_size 128m;
 
   location / {
@@ -345,3 +324,15 @@ server {
+ +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' %}