Merge branch 'master' into 3761-pull-list-worker

[arvados.git] / doc / install / install-docker.html.textile.liquid

diff --git a/doc/install/install-docker.html.textile.liquid b/doc/install/install-docker.html.textile.liquid
index 12cdfbe6a109cadf47045342020284d0692b0cfc..e84b59203e95d0af11973c544a1283e6c268c8eb 100644 (file)
--- a/doc/install/install-docker.html.textile.liquid
+++ b/doc/install/install-docker.html.textile.liquid
@@ -1,17 +1,16 @@
 ---
 layout: default
 navsection: installguide
-title: Installing with Docker
+title: Build and install docker images
 ...
 
-h2. Purpose
-
 This installation method is appropriate for local testing, evaluation, and development. For production use, this method is not recommended.
 
 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)
 
 h2. Download the source tree
 
@@ -24,7 +23,9 @@ See also: "Downloading the source code":https://arvados.org/projects/arvados/wik
 
 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 which will prompt for a few inputs and then build all the Docker containers (this will take a while): 
+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!):
 
 <notextile>
 <pre><code>
@@ -74,6 +75,24 @@ crosbymichael/skydns    latest              1923ce648d4c        5 months ago
 
 h2. Updating the Arvados Docker containers
 
+@build.sh@ takes a few optional arguments:
+
+<notextile>
+<pre><code>
+~$ <span class="userinput"> ./build.sh --help</span>
+
+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
+</code></pre></notextile>
+
 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:
 
 <notextile>