Merge branch 'master' into 2257-inequality-conditions
[arvados.git] / docker / README.md
index 63387d3384c2984cf3ba2617157e79a63a1f3f4d..f521b8c90135dfdcf06923c2b4d6f6ad0c56d14f 100644 (file)
@@ -39,27 +39,17 @@ Prerequisites
      none   /cgroup    cgroup    defaults    0    0
      $ sudo mount /cgroup
         </pre>
-
-  3. Enable IPv4 forwarding:
-
-     <pre>
-     $ grep ipv4.ip_forward /etc/sysctl.conf
-     net.ipv4.ip_forward=1
-     $ sudo sysctl net.ipv4.ip_forward=1
-     </pre>
         
-  4. [Download and run a docker binary from docker.io.](http://docs.docker.io/en/latest/installation/binaries/)
+  3. [Download and run a docker binary from docker.io.](http://docs.docker.io/en/latest/installation/binaries/)
 
-* Ruby (any version)
+* Ruby (version 1.9.3 or greater)
 
 * sudo privileges to run `debootstrap`
 
 Building
 --------
 
-1. Copy `config.yml.example` to `config.yml` and edit it with settings
-   for your installation.
-2. Run `make` to build the following Docker images:
+Type `./build.sh` to configure and build the following Docker images:
 
    * arvados/api       - the Arvados API server
    * arvados/doc       - Arvados documentation
@@ -67,33 +57,25 @@ Building
    * arvados/workbench - the Arvados console
    * arvados/sso       - the Arvados single-signon authentication server
 
-   You may also build Docker images for individual Arvados services:
-
-        $ make api-image
-        $ make doc-image
-        $ make warehouse-image
-        $ make workbench-image
-        $ make sso-image
+`build.sh` will generate reasonable defaults for all configuration
+settings.  If you want more control over the way Arvados is
+configured, first copy `config.yml.example` to `config.yml` and edit
+it with appropriate configuration settings, and then run `./build.sh`.
 
-Deploying
----------
+Running
+-------
 
-1. Make sure the `ARVADOS_DNS_SERVER` has been provisioned with the
-   following DNS entries, resolving to the appropriate IP addresses
-   where each service will be deployed.
+The `arvdock` script in this directory is used to start, stop and
+restart Arvados servers on your machine.  The simplest and easiest way
+to use it is `./arvdock start` to start the full complement of Arvados
+servers, and `./arvdock stop` and `./arvdock restart` to stop and
+restart all servers, respectively.
 
-   * $API_HOSTNAME
-   * keep0.$API_HOSTNAME
-   * compute0.$API_HOSTNAME
-   * controller.$API_HOSTNAME
-   * workbench.$API_HOSTNAME
+Developers who are working on individual servers can start, stop or
+restart just those containers, e.g.:
 
-2. The `arvdock` script in this directory is used to start, stop and
-   restart Arvados servers on your machine. Example usages:
+* `./arvdock start --api --sso` to start just the API and SSO services.
+* `./arvdock stop --keep` to stop just the Keep services.
+* `./arvdock restart --workbench=8000` restarts just the Workbench service on port 8000.
 
-   * `arvdock start`
-   * `arvdock stop`
-   * `arvdock restart`
-   * `arvdock start --api --sso` to start just the API and SSO services.
-   * `arvdock start --workbench=8000` starts just the Workbench service on port 8000.
-   * `arvdock stop --keep` to stop just the Keep services.
+For a full set of arguments, use `./arvdock --help`.