X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/ef56ac56a0bac0710a486c0e5e9cdd3199eddc61..3f7bde601546dc898975fbe7d56957794985fe43:/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 e1de8c3e60..7201460dde 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -3,179 +3,252 @@ layout: default navsection: installguide title: Install the API server ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -h2. Prerequisites: +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} -# A GNU/Linux (virtual) machine -# A domain name for your api server +h2. Install prerequisites -h2(#dependencies). Install dependencies +The Arvados package repository includes an API server package that can help automate much of the deployment. - -
~$ sudo apt-get install \
-    bison build-essential gettext libcurl3 libcurl3-gnutls \
-    libcurl4-openssl-dev libpcre3-dev libpq-dev libreadline-dev \
-    libsqlite3-dev libssl-dev libxslt1.1 postgresql sqlite3 sudo \
-    wget zlib1g-dev
-
+h3(#install_ruby_and_bundler). Install Ruby and Bundler + +{% include 'install_ruby_and_bundler' %} -h2(#ruby). Install Ruby and bundler +h2(#install_apiserver). Install API server and dependencies -We recommend Ruby >= 2.1. +On a Debian-based system, install the following packages: -
mkdir -p ~/src
-cd ~/src
-wget http://cache.ruby-lang.org/pub/ruby/2.1/ruby-2.1.2.tar.gz
-tar xzf ruby-2.1.2.tar.gz
-cd ruby-2.1.2
-./configure
-make
-sudo make install
+
~$ sudo apt-get install bison build-essential libcurl4-openssl-dev git arvados-api-server
+
+ -sudo gem install bundler
-
+On a Red Hat-based system, install the following packages: + + +
~$ sudo yum install bison make automake gcc gcc-c++ libcurl-devel git arvados-api-server
+
+
+ +{% include 'install_git' %} -h2. Download the source tree +h2(#configure). Set up the database + +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. -
~$ cd $HOME # (or wherever you want to install)
-~$ git clone https://github.com/curoverse/arvados.git
+
~$ editor /etc/arvados/api/database.yml
 
-See also: "Downloading the source code":https://arvados.org/projects/arvados/wiki/Download on the Arvados wiki. +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. + +@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 lowercase ASCII letters and digits. -h2. Install gem dependencies +Example @application.yml@: -
~$ cd arvados/services/api
-~/arvados/services/api$ bundle install
-
+
  uuid_prefix: zzzzz
+ -h2. Configure the API server +h3. secret_token -Edit the main configuration: +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@: -
~/arvados/services/api$ cp -i config/application.yml.example config/application.yml
+
~$ ruby -e 'puts rand(2**400).to_s(36)'
+yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
 
-Choose a unique 5-character alphanumeric string to use as your @uuid_prefix@. An example is given that generates a 5-character string based on a hash of your hostname. The @uuid_prefix@ is a unique identifier for your API server. It also serves as the first part of the hostname for your API server. +Example @application.yml@: + + +
  secret_token: yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
+
-For a development site, use your own domain instead of arvadosapi.com. +h3(#blob_signing_key). blob_signing_key -Make sure a clone of the arvados repository exists in @git_repositories_dir@: +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@: -
~/arvados/services/api$ sudo mkdir -p /var/cache/git
-~/arvados/services/api$ sudo git clone --bare ../../.git /var/cache/git/arvados.git
+
~$ ruby -e 'puts rand(2**400).to_s(36)'
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 
-Generate a new secret token for signing cookies: +Example @application.yml@: -
~/arvados/services/api$ rake secret
-zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
-
+
  blob_signing_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+ + +h3(#omniauth). sso_app_secret, sso_app_id, sso_provider_url -If you want access control on your Keep server(s), you should set @blob_signing_key@ to the same value as the permission key you provided to your "Keep server(s)":install-keep.html. +The following settings enable the API server to communicate with the "Single Sign On (SSO) server":install-sso.html to authenticate user log in. -Put it in @config/application.yml@ in the production or common section: +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. + +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@: -
    secret_token: zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+
  sso_app_id: arvados-server
+  sso_app_secret: wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww
+  sso_provider_url: https://sso.example.com
 
-Consult @application.default.yml@ for a full list of configuration options. Always put your local configuration in @application.yml@ instead of editing @application.default.yml@. +h3. workbench_address -Generate a new database password. Nobody ever needs to memorize it or type it, so we'll make a strong one: +Set @workbench_address@ to the URL of your workbench application after following "Install Workbench.":install-workbench-app.html + +Example @application.yml@: -
~/arvados/services/api$ ruby -e 'puts rand(2**128).to_s(36)'
-6gqa1vu492idd7yca9tfandj3
-
+
  workbench_address: https://workbench.zzzzz.example.com
+ -Create a new database user with permission to create its own databases. +h3. websocket_address - -
~/arvados/services/api$ sudo -u postgres createuser --createdb --encrypted --pwprompt arvados
-[sudo] password for you: yourpassword
-Enter password for new role: paste-password-you-generated
-Enter it again: paste-password-again
-Shall the new role be a superuser? (y/n) n
-Shall the new role be allowed to create more new roles? (y/n) n
-
+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@. -Configure API server to connect to your database by creating and updating @config/database.yml@. Replace the @xxxxxxxx@ database password placeholders with the new password you generated above. +Example @application.yml@: -
~/arvados/services/api$ cp -i config/database.yml.sample config/database.yml
-~/arvados/services/api$ edit config/database.yml
-
+
  websocket_address: wss://ws.zzzzz.example.com/websocket
+ -Create and initialize the database. +h3(#git_repositories_dir). git_repositories_dir - -
~/arvados/services/api$ RAILS_ENV=development bundle exec rake db:setup
-
+The @git_repositories_dir@ setting specifies the directory where user git repositories will be stored. -Set up omniauth: +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: -
~/arvados/services/api$ cp -i config/initializers/omniauth.rb.example config/initializers/omniauth.rb
+
~$ sudo mkdir -p /var/lib/arvados/git/repositories
 
-Edit @config/initializers/omniauth.rb@, and tell your api server to use the Curoverse SSO server for authentication: +If you intend to store your git repositories in a different location, specify that location in @application.yml@. + +Default setting in @application.default.yml@: -
APP_ID = 'local_docker_installation'
-APP_SECRET = 'yohbai4eecohshoo1Yoot7tea9zoca9Eiz3Tajahweo9eePaeshaegh9meiye2ph'
-CUSTOM_PROVIDER_URL = 'https://auth.curoverse.com'
-
-
+
  git_repositories_dir: /var/lib/arvados/git/repositories
+
+
-
- -

Note!

-

You can also run your own SSO server. However, the SSO server codebase currently uses OpenID 2.0 to talk to Google's authentication service. Google has deprecated that protocol. This means that new clients will not be allowed to talk to Google's authentication services anymore over OpenID 2.0, and they will phase out the use of OpenID 2.0 completely in the coming monts. We are working on upgrading the SSO server codebase to a newer protocol. That work should be complete by the end of November 2014. In the mean time, anyone is free to use the existing Curoverse SSO server for any local Arvados installation.

-
+h3(#git_internal_dir). git_internal_dir -You can now run the development server: +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@. + +Example @application.yml@: -
~/arvados/services/api$ bundle exec rails server --port=3030
-
+
  git_internal_dir: /var/lib/arvados/internal.git
+
+ -h3. Apache/Passenger (optional) +h2(#set_up). Set up Nginx and Passenger -You can use "Passenger":https://www.phusionpassenger.com/ for deployment. Point it to the services/api directory in the source tree. +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. -To enable streaming so users can monitor crunch jobs in real time, add to your Passenger configuration in Apache: +First, "Install Nginx and Phusion Passenger":https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_passenger_main.html. + +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: -
PassengerBufferResponse off
+
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;
+}
+
+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;
+  }
+}
 
-h2(#admin-user). Add an admin user - -Point your browser to the API server's login endpoint: +Restart Nginx to apply the new configuration. -
https://localhost:3030/login
+
~$ sudo nginx -s reload
 
-Log in with your google account. +h2. Prepare the API server deployment -Use the rails console to give yourself admin privileges: +{% assign railspkg = "arvados-api-server" %} +{% include 'install_rails_reconfigure' %} - -
~/arvados/services/api$ bundle exec rails console
-irb(main):001:0> Thread.current[:user] = User.all.select(&:identity_url).last
-irb(main):002:0> Thread.current[:user].is_admin = true
-irb(main):003:0> Thread.current[:user].update_attributes is_admin: true, is_active: true
-irb(main):004:0> User.where(is_admin: true).collect &:email
-=> ["root", "your_address@example.com"]
-
+{% 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' %}