docker/README

   1 Deploying Arvados in Docker Containers
   2 ======================================
   3
   4 This file explains how to build and deploy Arvados servers in Docker
   5 containers, so that they can be run easily in different environments
   6 (a dedicated server, a developer's laptop, a virtual machine,
   7 etc).
   8
   9 This is a work in progress; instructions will almost certainly be
  10 incomplete and possibly out of date.
  11
  12 PREREQUISITES
  13 -------------
  14
  15 * Docker
  16
  17   Docker is a Linux container management system based on LXC. It is a
  18   very young system but is being developed rapidly.  See
  19   http://www.docker.io/gettingstarted/#h_installation for an
  20   installation package for your platform.
  21
  22 * Ruby (any version)
  23
  24 BUILDING
  25 --------
  26
  27 1. Before building, edit config.yml with settings for your
  28    installation.
  29
  30 2. Run `./config.rb' to generate configuration files.
  31
  32 3. Add a DNS entry for your API_HOSTNAME which resolves to the machine
  33    that the API container will be deployed to.
  34
  35 4. Provision your Omniauth server with the APP_ID and
  36    APP_SECRET from api/omniauth.rb.
  37
  38 5. Run `./build.sh' to build the following Docker images:
  39
  40      arvados/api    - the Arvados API server
  41      arvados/keep   - Keep, the Arvados content-addressable filesystem
  42      arvados/crunch - Crunch, a compute node for Arvados
  43