doc/install/arvbox.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Arvados-in-a-box
   5 ...
   6
   7 Arvbox is a Docker-based self-contained development, demonstration and testing environment for Arvados.  It is not intended for production use.
   8
   9 h2. Quick start
  10
  11 <pre>
  12 $ git clone https://github.com/curoverse/arvados.git
  13 $ cd arvados/tools/arvbox/bin
  14 $ ./arvbox start localdemo
  15 </pre>
  16
  17 h2. Requirements
  18
  19 * Linux 3.x+ and Docker 1.9+
  20 * Minimum of 3 GiB of RAM  + additional memory to run jobs
  21 * Minimum of 3 GiB of disk + storage for actual data
  22
  23 h2. Usage
  24
  25 <pre>
  26 $ arvbox
  27 Arvados-in-a-box                      http://arvados.org
  28
  29 build   <config>      build arvbox Docker image
  30 rebuild <config>      build arvbox Docker image, no layer cache
  31 start|run <config>  start arvbox container
  32 open       open arvbox workbench in a web browser
  33 shell      enter arvbox shell
  34 ip         print arvbox docker container ip address
  35 host       print arvbox published host
  36 status     print some information about current arvbox
  37 stop       stop arvbox container
  38 restart <config>  stop, then run again
  39 reboot  <config>  stop, build arvbox Docker image, run
  40 reset      delete arvbox arvados data (be careful!)
  41 destroy    delete all arvbox code and data (be careful!)
  42 log <service> tail log of specified service
  43 ls <options>  list directories inside arvbox
  44 cat <files>   get contents of files inside arvbox
  45 pipe       run a bash script piped in from stdin
  46 sv <start|stop|restart> <service> change state of service inside arvbox
  47 clone <from> <to>   clone an arvbox
  48 </pre>
  49
  50 h2. Configs
  51
  52 h3. dev
  53
  54 Development configuration.  Boots a complete Arvados environment inside the container.  The "arvados", "arvado-dev" and "sso-devise-omniauth-provider" 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.
  55
  56 In "dev" mode, you can override the default autogenerated settings of Rails projects by adding "application.yml.override" to any Rails project (sso, api, workbench).  This can be used to test out API server settings or point Workbench at an alternate API server.
  57
  58 h3. localdemo
  59
  60 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.
  61
  62 h3. test
  63
  64 Run the test suite.
  65
  66 h3. publicdev
  67
  68 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.
  69
  70 h3. publicdemo
  71
  72 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.
  73
  74 h2. Environment variables
  75
  76 h3. ARVBOX_DOCKER
  77
  78 The location of Dockerfile.base and associated files used by "arvbox build".
  79 default: result of $(readlink -f $(dirname $0)/../lib/arvbox/docker)
  80
  81 h3. ARVBOX_CONTAINER
  82
  83 The name of the Docker container to manipulate.
  84 default: arvbox
  85
  86 h3. ARVBOX_BASE
  87
  88 The base directory to store persistent data for arvbox containers.
  89 default: $HOME/.arvbox
  90
  91 h3. ARVBOX_DATA
  92
  93 The base directory to store persistent data for the current container.
  94 default: $ARVBOX_BASE/$ARVBOX_CONTAINER
  95
  96 h3. ARVADOS_ROOT
  97
  98 The root directory of the Arvados source tree
  99 default: $ARVBOX_DATA/arvados
 100
 101 h3. ARVADOS_DEV_ROOT
 102
 103 The root directory of the Arvados-dev source tree
 104 default: $ARVBOX_DATA/arvados-dev
 105
 106 h3. SSO_ROOT
 107
 108 The root directory of the SSO source tree
 109 default: $ARVBOX_DATA/sso-devise-omniauth-provider
 110
 111 h3. ARVBOX_PUBLISH_IP
 112
 113 The IP address on which to publish services when running in public configuration.  Overrides default detection of the host's IP address.
 114
 115 h2. Using Arvbox for Arvados development
 116
 117 The "Arvbox section of Hacking Arvados":https://dev.arvados.org/projects/arvados/wiki/Arvbox has information about using Arvbox for Arvados development.
 118
 119 h2. Making Arvbox accessible from other hosts
 120
 121 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@:
 122
 123 <pre>
 124 $ arvbox start publicdemo
 125 </pre>
 126
 127 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.
 128
 129 <pre>
 130 $ export ARVBOX_PUBLISH_IP=example.com
 131 $ arvbox start publicdemo
 132 </pre>
 133
 134 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.
 135
 136 h2. Notes
 137
 138 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.
 139
 140 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.