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

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install pre-built Docker images
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 This method is intended for evaluation and development on a local workstation. It is not suitable for production use in a cluster deployment.
  13
  14 {% include 'notebox_begin' %}
  15 * The automatic network configuration allows you to log in to Workbench from a browser _running on the same host as Docker_. Connecting from other hosts requires additional configuration (not covered here).
  16 * Your data will be stored inside the Docker containers.  You may stop and restart the containers without loss, but if you delete the container, your data will be gone.
  17 * Updating the Arvados software inside the Docker containers is not supported.  You may download updated Docker images, but migrating data to updated containers is not yet supported.
  18 {% include 'notebox_end' %}
  19
  20 h2. Prerequisites
  21
  22 # A GNU/Linux x64 (virtual) machine
  23 # A working Docker installation (see "Installing Docker":https://docs.docker.com/installation/)
  24 # curl
  25
  26 h2. Verify prerequisites
  27
  28 Make sure that @curl@ and @docker@ are installed on your system, and that you are in the docker group (see "Installing Docker":https://docs.docker.com/installation/).
  29
  30 <notextile><pre><code>~$ <span class="userinput">which curl</span>
  31 /usr/bin/curl
  32 ~$ <span class="userinput">docker.io --version</span>
  33 Docker version 1.2.0-dev, build dc243c8
  34 ~$ <span class="userinput">groups</span>
  35 yourusername sudo fuse docker
  36 </code></pre></notextile>
  37
  38 h2. Download and install Arvados.
  39
  40 <notextile>
  41 <pre><code>~$ <span class="userinput">\curl -sSL get.arvados.org | bash</span>
  42 </code></pre></notextile>
  43
  44 This command will download the latest build of the Arvados docker images. It also gets the @arvdock@ command and saves it in the current working directory. It then uses @arvdock@ to spin up Arvados. Note that the Arvados Docker images are large and may take a while to download.
  45
  46 If you prefer, you can also download and inspect the installation script before running it. @get.arvados.org@ redirects to "https://raw.githubusercontent.com/curoverse/arvados-dev/master/install/easy-docker-install.sh":https://raw.githubusercontent.com/curoverse/arvados-dev/master/install/easy-docker-install.sh, which is the installation script.
  47
  48 The @arvdock@ command usage is listed here:
  49
  50 <pre>
  51 usage: ./arvdock (start|stop|restart|reset|test) [options]
  52
  53 start    run new or restart stopped arvados containers
  54 stop     stop arvados containers
  55 restart  stop and then start arvados containers
  56 reset    stop and delete containers WARNING: this will delete the data inside Arvados!
  57 test     run tests
  58
  59 ./arvdock start/stop/restart options:
  60   -d[port], --doc[=port]        Documentation server (default port 9898)
  61   -w[port], --workbench[=port]  Workbench server (default port 9899)
  62   -s[port], --sso[=port]        SSO server (default port 9901)
  63   -a[port], --api[=port]        API server (default port 9900)
  64   -c, --compute                 Compute nodes (starts 2)
  65   -v, --vm                      Shell server
  66   -n, --nameserver              Nameserver
  67   -k, --keep                    Keep servers
  68   -p, --keepproxy               Keepproxy server
  69   -h, --help                    Display this help and exit
  70
  71   If no options are given, the action is applied to all servers.
  72
  73 ./arvdock test [testname] [testname] ...
  74   By default, all tests are run.
  75 </pre>