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