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

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install pre-built Docker images
   5 ...
   6
   7 This method is intended for evaluation and development on a local workstation. It is not suitable for production use in a cluster deployment.
   8
   9 {% include 'notebox_begin' %}
  10 * 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).
  11 * 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.
  12 * 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.
  13 {% include 'notebox_end' %}
  14
  15 h2. Prerequisites
  16
  17 # A GNU/Linux x64 (virtual) machine
  18 # A working Docker installation (see "Installing Docker":https://docs.docker.com/installation/)
  19 # curl
  20
  21 h2. Verify prerequisites
  22
  23 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/).
  24
  25 <notextile><pre><code>~$ <span class="userinput">which curl</span>
  26 /usr/bin/curl
  27 ~$ <span class="userinput">docker.io --version</span>
  28 Docker version 1.2.0-dev, build dc243c8
  29 ~$ <span class="userinput">groups</span>
  30 yourusername sudo fuse docker
  31 </code></pre></notextile>
  32
  33 h2. Download and install Arvados.
  34
  35 <notextile>
  36 <pre><code>~$ <span class="userinput">\curl -sSL get.arvados.org | bash</span>
  37 </code></pre></notextile>
  38
  39 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.
  40
  41 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.
  42
  43 The @arvdock@ command usage is listed here:
  44
  45 <pre>
  46 usage: ./arvdock (start|stop|restart|reset|test) [options]
  47
  48 start    run new or restart stopped arvados containers
  49 stop     stop arvados containers
  50 restart  stop and then start arvados containers
  51 reset    stop and delete containers WARNING: this will delete the data inside Arvados!
  52 test     run tests
  53
  54 ./arvdock start/stop/restart options:
  55   -d[port], --doc[=port]        Documentation server (default port 9898)
  56   -w[port], --workbench[=port]  Workbench server (default port 9899)
  57   -s[port], --sso[=port]        SSO server (default port 9901)
  58   -a[port], --api[=port]        API server (default port 9900)
  59   -c, --compute                 Compute nodes (starts 2)
  60   -v, --vm                      Shell server
  61   -n, --nameserver              Nameserver
  62   -k, --keep                    Keep servers
  63   -p, --keepproxy               Keepproxy server
  64   -h, --help                    Display this help and exit
  65
  66   If no options are given, the action is applied to all servers.
  67
  68 ./arvdock test [testname] [testname] ...
  69   By default, all tests are run.
  70 </pre>