---
layout: default
navsection: installguide
title: Build and install Docker images
...
This method is intended for evaluation and development on a local workstation. It is not suitable for production use in a cluster deployment.
h2. Prerequisites
# A GNU/Linux (virtual) machine
# A working Docker installation (see "Installing Docker":https://docs.docker.com/installation/)
# A working Go installation (see "Install the Go tools":https://golang.org/doc/install)
# A working Ruby installation, with the Bundler gem installed
h3. Install Ruby and Bundler
{% include 'install_ruby_and_bundler' %}
h2. Download the source tree
~$ cd $HOME # (or wherever you want to install)
~$ git clone https://github.com/curoverse/arvados.git
See also: "Downloading the source code":https://arvados.org/projects/arvados/wiki/Download on the Arvados wiki.
h2. Building the Arvados Docker containers
First of all, a suitable @config.yml@ file is needed. The easiest way to generate one based on the provided @config.yml.example@ file is to run the @build.sh@ script. If no @config.yml@ file exists, it will will prompt for a few inputs, write the @config.yml@ file, and then proceed to build all the Docker containers. If @config.yml@ exists, invoking @build.sh@ will simply build all Docker containers or update those that need to be updated.
Run @build.sh@ without arguments to generate @config.yml@ and build all Docker containers (this will take a while!):
~$ ./build.sh
Generating config.yml.
Arvados needs to know the email address of the administrative user,
so that when that user logs in they are automatically made an admin.
This should be an email address associated with a Google account.
Enter your Google ID email address here:
...
Step 7 : ADD generated/setup.sh /usr/local/bin/setup.sh
---> d7c0e7fdf7ab
Removing intermediate container f3d81180795d
Step 8 : CMD ["/usr/bin/supervisord", "-n"]
---> Running in 84c64cb9f0d5
---> d6cbb5002604
Removing intermediate container 84c64cb9f0d5
Successfully built d6cbb5002604
date >shell-image
If all goes well, you should now have a number of Docker images built (the image id will be different):
~$ docker.io images
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE
arvados/shell latest d6cbb5002604 10 minutes ago 1.613 GB
arvados/sso latest 377f1fa0108e 11 minutes ago 1.807 GB
arvados/keep latest ade0e0d2dd00 12 minutes ago 210.8 MB
arvados/keepproxy latest b39ef0baba02 12 minutes ago 241.6 MB
arvados/workbench latest b0e4fb6da385 12 minutes ago 2.218 GB
arvados/doc latest 4b64daec9454 12 minutes ago 1.524 GB
arvados/compute latest 7f1f5f7faf54 13 minutes ago 1.862 GB
arvados/slurm latest f5bfd1008e6b 17 minutes ago 1.573 GB
arvados/api latest 6b93c5f5fc42 17 minutes ago 2.274 GB
arvados/passenger latest add2d11fdf24 18 minutes ago 1.738 GB
arvados/base latest 81eaadd0c6f5 22 minutes ago 1.463 GB
arvados/debian 7.6 f339ce275c01 6 days ago 116.8 MB
arvados/debian latest f339ce275c01 6 days ago 116.8 MB
arvados/debian wheezy f339ce275c01 6 days ago 116.8 MB
crosbymichael/skydock latest e985023521f6 3 months ago 510.7 MB
crosbymichael/skydns next 79c99a4608ed 3 months ago 525 MB
crosbymichael/skydns latest 1923ce648d4c 5 months ago 137.5 MB
h2. Updating the Arvados Docker containers
@build.sh@ takes a few optional arguments:
~$ ./build.sh --help
usage: ./build.sh [options]
Calling ./build.sh without arguments will build all Arvados docker images
./build.sh options:
-h, --help Print this help text
clean Clear all build information
realclean clean and remove all Arvados Docker images except arvados/debian
deepclean realclean and remove arvados/debian, crosbymichael/skydns and
crosbymichael/skydns Docker images
If there has been an update to the Arvados Docker building code, it is safest to rebuild the Arvados Docker images from scratch. All build information can be cleared with the 'clean' option to build.sh:
~$ ./build.sh clean
You can also use 'realclean', which does what 'clean' does and in addition removes all Arvados Docker containers and images from your system, with the exception of the arvados/debian image.
~$ ./build.sh realclean
Finally, the 'deepclean' option does what 'realclean' does, and also removes the arvados/debian, crosbymichael/skydns and crosbymichael/skydock images.
~$ ./build.sh deepclean
h2. Running the Arvados Docker containers
The @arvdock@ command can be used to start and stop the docker containers. It has a number of options:
~$ ./arvdock -h
usage: ./arvdock (start|stop|restart|reset|test) [options]
start run new or restart stopped arvados containers
stop stop arvados containers
restart stop and then start arvados containers
reset stop and delete containers WARNING: this will delete the data inside Arvados!
test run tests
./arvdock start/stop/restart options:
-d[port], --doc[=port] Documentation server (default port 9898)
-w[port], --workbench[=port] Workbench server (default port 9899)
-s[port], --sso[=port] SSO server (default port 9901)
-a[port], --api[=port] API server (default port 9900)
-c, --compute Compute nodes (starts 2)
-v, --vm Shell server
-n, --nameserver Nameserver
-k, --keep Keep servers
-p, --keepproxy Keepproxy server
-h, --help Display this help and exit
If no options are given, the action is applied to all servers.
./arvdock test [testname] [testname] ...
By default, all tests are run.
To debug issues with the Docker containers use @docker exec@, for example:
~$ docker exec -t -i api_server /bin/bash
To start the docker containers:
~$ ./arvdock start
start_api=false
start_compute=false
start_doc=false
start_keep=false
start_keepproxy=false
start_nameserver=false
start_sso=false
start_vm=false
start_workbench=false
Starting crosbymichael/skydns container...
skydns
/usr/bin/docker.io run -d -p 172.17.42.1:53:53/udp --name skydns crosbymichael/skydns -nameserver 8.8.8.8:53 -domain arvados
89922ec786cbd2098ed6bae205468a675657cdb2db0e0bfdfe76d1e43cb2fe35
Starting crosbymichael/skydock container...
skydock
/usr/bin/docker.io run -d -v /var/run/docker.sock:/docker.sock --name skydock crosbymichael/skydock -ttl 30 -environment dev -s /docker.sock -domain arvados -name skydns
de6a35bb20fb9063fb97218ba2554974546eed969d43b1f5aa31a1ac9576e802
Starting container: api_server
/usr/bin/docker.io start api_server
Started container: api_server
Starting container: compute0
/usr/bin/docker.io start compute0
Started container: compute0
Starting container: compute1
/usr/bin/docker.io start compute1
Started container: compute1
Starting container: keep_server_0
/usr/bin/docker.io start keep_server_0
Started container: keep_server_0
Starting container: keep_server_1
/usr/bin/docker.io start keep_server_1
Started container: keep_server_1
Starting container: keepproxy_server
/usr/bin/docker.io start keepproxy_server
Started container: keepproxy_server
Starting container: doc_server
/usr/bin/docker.io start doc_server
Started container: doc_server
******************************************************************
You can access the Arvados documentation at http://doc.dev.arvados
******************************************************************
Starting container: shell
/usr/bin/docker.io start shell
Started container: shell
Starting container: workbench_server
/usr/bin/docker.io start workbench_server
Started container: workbench_server
********************************************************************
You can access the Arvados workbench at http://workbench.dev.arvados
********************************************************************
*****************************************************************
To access Arvados you must add the Arvados nameserver to the top
of your DNS configuration in /etc/resolv.conf:
nameserver 172.17.42.1
******************************************************************
h2. Accessing workbench
Point your browser to the Dockerized workbench:
http://workbench.dev.arvados
Now use the google account you specified as @API_AUTO_ADMIN_USER@ in @config.yml@ to log in.
You will be prompted by your browser that you are accessing a site with an untrusted SSL certificate. This is normal; by default the Arvados Docker installation uses self-signed SSL certificates for the SSO and API servers, respectively. If you use a local SSO server in a Docker container, you will be prompted *twice*. The default is to use the Curoverse SSO server.