doc/install/arvbox.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Arvados-in-a-box
   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 Arvbox is a Docker-based self-contained development, demonstration and testing environment for Arvados.  It is not intended for production use.
  13
  14 h2. Requirements
  15
  16 * Linux 3.x+ and Docker 1.10+
  17 * Minimum of 4 GiB of RAM  + additional memory to run jobs
  18 * Minimum of 4 GiB of disk + storage for actual data
  19
  20 h2. Quick start
  21
  22 {% include 'branchname' %}
  23
  24 <notextile>
  25 <pre><code>$ <span class="userinput">curl -O <a href="https://git.arvados.org/arvados.git/blob_plain/refs/heads/{{branchname}}:/tools/arvbox/bin/arvbox">https://git.arvados.org/arvados.git/blob_plain/refs/heads/{{branchname}}:/tools/arvbox/bin/arvbox</a></span>
  26 $ <span class="userinput">chmod +x arvbox</span>
  27 $ <span class="userinput">./arvbox start localdemo</span>
  28
  29 Arvados-in-a-box starting
  30
  31 Waiting for workbench2 websockets workbench webshell keep-web controller keepproxy api keepstore1 arv-git-httpd keepstore0 sdk vm ...
  32 ...
  33
  34 Your Arvados-in-a-box is ready!
  35
  36 $ <span class="userinput">./arvbox adduser demouser demo@example.com</span>
  37 Password for demouser:
  38 Added demouser
  39 </code></pre>
  40 </notextile>
  41
  42 You will then need to "install the arvbox root certificate":#root-cert .  After that, you can now log in to Workbench as @demouser@ with the password you selected.
  43
  44 h2(#root-cert). Install root certificate
  45
  46 Arvbox creates root certificate to authorize Arvbox services.  Installing the root certificate into your web browser will prevent security errors when accessing Arvbox services with your web browser.  Every  Arvbox instance generates a new root signing key.
  47
  48 Export the root certificate with this command:
  49
  50 <pre>
  51 $ ./arvbox root-cert
  52 Certificate copied to /home/ubuntu/arvbox-root-cert.crt
  53 </pre>
  54
  55 {% assign ca_cert_name = 'arvbox-root-cert.crt' %}
  56
  57 {% include 'install_ca_cert' %}
  58
  59 h2. Usage
  60
  61 <pre>
  62 $ arvbox
  63 Arvados-in-a-box             https://doc.arvados.org/install/arvbox.html
  64
  65 start|run <config> [tag]   start arvbox container
  66 stop               stop arvbox container
  67 restart <config>   stop, then run again
  68 status             print some information about current arvbox
  69 ip                 print arvbox docker container ip address
  70 host               print arvbox published host
  71 shell              enter shell as root
  72 ashell             enter shell as 'arvbox'
  73 psql               enter postgres console
  74 open               open arvbox workbench in a web browser
  75 root-cert          get copy of root certificate
  76 update  <config>   stop, pull latest image, run
  77 build   <config>   build arvbox Docker image
  78 reboot  <config>   stop, build arvbox Docker image, run
  79 rebuild <config>   build arvbox Docker image, no layer cache
  80 checkpoint         create database backup
  81 restore            restore checkpoint
  82 hotreset           reset database and restart API without restarting container
  83 reset              delete arvbox arvados data (be careful!)
  84 destroy            delete all arvbox code and data (be careful!)
  85 log <service>      tail log of specified service
  86 ls <options>       list directories inside arvbox
  87 cat <files>        get contents of files inside arvbox
  88 pipe               run a bash script piped in from stdin
  89 sv <start|stop|restart> <service>
  90                    change state of service inside arvbox
  91 clone <from> <to>  clone dev arvbox
  92 adduser <username> <email> [password]
  93                    add a user login
  94 removeuser <username>
  95                    remove user login
  96 listusers          list user logins
  97 </pre>
  98
  99 h2. Configs
 100
 101 h3. dev
 102
 103 Development configuration.  Boots a complete Arvados environment inside the container.  The "arvados" and "arvados-dev" code directories along data directories "postgres", "var", "passenger" and "gems" are bind mounted from the host file system for easy access and persistence across container rebuilds.  Services are bound to the Docker container's network IP address and can only be accessed on the local host.
 104
 105 In "dev" mode, you can override the default autogenerated settings of Rails projects by adding "application.yml.override" to any Rails project (api, workbench).  This can be used to test out API server settings or point Workbench at an alternate API server.
 106
 107 h3. localdemo
 108
 109 Demo configuration.  Boots a complete Arvados environment inside the container. Unlike the development configuration, code directories are included in the demo image, and data directories are stored in a separate data volume container. Services are bound to the Docker container's network IP address and can only be accessed on the local host.
 110
 111 h3. test
 112
 113 Starts postgres and initializes the API server, then runs the Arvados test suite.  Will pass command line arguments to test runner.  Supports test runner interactive mode.
 114
 115 h3. devenv
 116
 117 Starts a minimal container with no services and the host's $HOME bind mounted inside the container, then enters an interactive login shell.  Intended to make it convenient to use tools installed in arvbox that don't require services.
 118
 119 h3. publicdev
 120
 121 Publicly accessible development configuration.  Similar to 'dev' except that service ports are published to the host's IP address and can accessed by anyone who can connect to the host system.  See below for more information.  WARNING! The public arvbox configuration is NOT SECURE and must not be placed on a public IP address or used for production work.
 122
 123 h3. publicdemo
 124
 125 Publicly accessible development configuration.  Similar to 'localdemo' except that service ports are published to the host's IP address and can accessed by anyone who can connect to the host system.  See below for more information.  WARNING! The public arvbox configuration is NOT SECURE and must not be placed on a public IP address or used for production work.
 126
 127 h2. Environment variables
 128
 129 h3. ARVBOX_DOCKER
 130
 131 The location of Dockerfile.base and associated files used by "arvbox build".
 132 default: result of $(readlink -f $(dirname $0)/../lib/arvbox/docker)
 133
 134 h3. ARVBOX_CONTAINER
 135
 136 The name of the Docker container to manipulate.
 137 default: arvbox
 138
 139 h3. ARVBOX_BASE
 140
 141 The base directory to store persistent data for arvbox containers.
 142 default: $HOME/.arvbox
 143
 144 h3. ARVBOX_DATA
 145
 146 The base directory to store persistent data for the current container.
 147 default: $ARVBOX_BASE/$ARVBOX_CONTAINER
 148
 149 h3. ARVADOS_ROOT
 150
 151 The root directory of the Arvados source tree
 152 default: $ARVBOX_DATA/arvados
 153
 154 h3. ARVADOS_DEV_ROOT
 155
 156 The root directory of the Arvados-dev source tree
 157 default: $ARVBOX_DATA/arvados-dev
 158
 159 h3. ARVBOX_PUBLISH_IP
 160
 161 The IP address on which to publish services when running in public configuration.  Overrides default detection of the host's IP address.
 162
 163 h2. Using Arvbox for Arvados development
 164
 165 The "Arvbox section of Hacking Arvados":https://dev.arvados.org/projects/arvados/wiki/Arvbox has information about using Arvbox for Arvados development.
 166
 167 h2. Making Arvbox accessible from other hosts
 168
 169 In "dev" and "localdemo" mode, Arvbox can only be accessed on the same host it is running.  To publish Arvbox service ports to the host's service ports and advertise the host's IP address for services, use @publicdev@ or @publicdemo@:
 170
 171 <pre>
 172 $ arvbox start publicdemo
 173 </pre>
 174
 175 This attempts to auto-detect the correct IP address to use by taking the IP address of the default route device.  If the auto-detection is wrong, you want to publish a hostname instead of a raw address, or you need to access it through a different device (such as a router or firewall), set @ARVBOX_PUBLISH_IP@ to the desire hostname or IP address.
 176
 177 <pre>
 178 $ export ARVBOX_PUBLISH_IP=example.com
 179 $ arvbox start publicdemo
 180 </pre>
 181
 182 Note: this expects to bind the host's port 80 (http) for workbench, so you cannot have a conflicting web server already running on the host.  It does not attempt to take bind the host's port 22 (ssh), as a result the arvbox ssh port is not published.
 183
 184 h2. Notes
 185
 186 Services are designed to install and auto-configure on start or restart.  For example, the service script for keepstore always compiles keepstore from source and registers the daemon with the API server.
 187
 188 Services are run with process supervision, so a service which exits will be restarted.  Dependencies between services are handled by repeatedly trying and failing the service script until dependencies are fulfilled (by other service scripts) enabling the service script to complete.