doc/install/install-docker.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Installing with Docker
   5 ...
   6
   7 {% include 'alert_docker' %}
   8
   9 h2. Prerequisites:
  10
  11 # A GNU/Linux (virtual) machine
  12 # A working Docker installation
  13
  14 h2. Download the source tree
  15
  16 <notextile>
  17 <pre><code>~$ <span class="userinput">cd $HOME</span> # (or wherever you want to install)
  18 ~$ <span class="userinput">git clone https://github.com/curoverse/arvados.git</span>
  19 </code></pre></notextile>
  20
  21 See also: "Downloading the source code":https://arvados.org/projects/arvados/wiki/Download on the Arvados wiki.
  22
  23 h2. Building the Arvados Docker containers
  24
  25 First we need a suitable @config.yml@ file.
  26
  27 <notextile>
  28 <pre><code>~$ <span class="userinput">cd arvados/docker</span>
  29 ~$ <span class="userinput">cp config.yml.example config.yml</span>
  30 </code></pre></notextile>
  31
  32 Now it's time to edit the @config.yml@ file and fill in suitable values for at a minimum these parameters:
  33
  34 <pre>
  35 PUBLIC_KEY_PATH
  36 API_HOSTNAME
  37 API_AUTO_ADMIN_USER
  38 </pre>
  39
  40 h2. Running the Arvados Docker containers
  41
  42 The @arvdock@ command can be used to start and stop the docker containers. It has a number of options:
  43
  44 <notextile>
  45 <pre><code>
  46 ~$ <span class="userinput">./arvdock -h</span>
  47
  48 usage: ./arvdock (start|stop|restart|test) [options]
  49
  50 ./arvdock start/stop/restart options:
  51   -d [port], --doc[=port]        Documentation server (default port 9898)
  52   -w [port], --workbench[=port]  Workbench server (default port 9899)
  53   -s [port], --sso[=port]        SSO server (default port 9901)
  54   -a [port], --api[=port]        API server (default port 9900)
  55   -k, --keep                     Keep servers
  56   --ssh                          Enable SSH access to server containers
  57   -h, --help                     Display this help and exit
  58
  59   If no options are given, the action is applied to all servers.
  60
  61 ./arvdock test [testname] [testname] ...
  62   By default, all tests are run.
  63 </code>
  64 </pre>
  65 </notextile>
  66
  67 The @--ssh@ option can be useful to debug issues with the Docker containers; it allows you to ssh into the running containers as the @root@ user, provided you have access to the private key that matches the public key specified in @config.yml@'s PUBLIC_KEY_PATH variable.
  68
  69 Start the docker containers:
  70
  71 <notextile>
  72 <pre><code>
  73 ~$ <span class="userinput">./arvdock start</span>
  74 sso_server
  75 Starting container:
  76   /usr/bin/docker.io run -d -i -t -p 9901:443 --name sso_server arvados/sso
  77 api_server
  78 Starting container:
  79   /usr/bin/docker.io run -d -i -t -p 9900:443 --name api_server --link sso_server:sso arvados/api
  80 keep_server_0
  81 Starting container:
  82   /usr/bin/docker.io run -d -i -t -p 25107:25107 --name keep_server_0 -v /tmp/tmp.aCSx8Pq6Wb:/dev/keep-0 --link api_server:api arvados/keep
  83 keep_server_1
  84 Starting container:
  85   /usr/bin/docker.io run -d -i -t -p 25108:25107 --name keep_server_1 -v /tmp/tmp.m4OQ9WB73G:/dev/keep-0 --link api_server:api arvados/keep
  86 doc_server
  87 Starting container:
  88   /usr/bin/docker.io run -d -i -t -p 9898:80 --name doc_server arvados/doc
  89
  90 *****************************************************************
  91 You can access the Arvados documentation at http://localhost:9898
  92 *****************************************************************
  93
  94 workbench_server
  95 Starting container:
  96   /usr/bin/docker.io run -d -i -t -p 9899:80 --name workbench_server --link api_server:api arvados/workbench
  97
  98 *****************************************************************
  99 You can access the Arvados workbench at http://localhost:9899
 100 *****************************************************************
 101 </code></pre></notextile>
 102
 103 h2. Accessing workbench
 104
 105 Point your browser to the Dockerized workbench:
 106
 107 <notextile>
 108 <pre><code><span class="userinput">https://localhost:9899</span>
 109 </code></pre>
 110 </notextile>
 111
 112 Now use the google account you specified as @API_AUTO_ADMIN_USER@ in @config.yml@ to log in. You will be prompted *twice* by your browser that you are accessing a site with an untrusted SSL certificate. This is normal; by default the Arvados Docker installation uses self-signed SSL certificates for the SSO and API servers, respectively.
 113
 114