X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/6a983720b3d1ee8e613bf3902e69fd14f505b995..5fcca42249b8b35f50beb9ed4c51d090d76c1767:/doc/install/pre-built-docker.html.textile.liquid
diff --git a/doc/install/pre-built-docker.html.textile.liquid b/doc/install/pre-built-docker.html.textile.liquid
index fb87195e3e..6f92c351d4 100644
--- a/doc/install/pre-built-docker.html.textile.liquid
+++ b/doc/install/pre-built-docker.html.textile.liquid
@@ -1,17 +1,31 @@
---
layout: default
navsection: installguide
-title: Install pre-built docker images
+title: Install pre-built Docker images
...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+
+This method is intended for evaluation and development on a local workstation. It is not suitable for production use in a cluster deployment.
{% include 'notebox_begin' %}
-This method is easy, but is not yet suitable for production use. It is still in development: some features do not work yet.
-* Websockets service is not enabled. This means Workbench auto-refresh and web upload (and some other features) do not work.
-* The node manager is not enabled. Two worker containers are brought up at startup.
-* The automatic network configuration allows you to log in to Workbench from a browser _running on the same host as docker_. Connecting from other hosts will require additional configuration (not covered here).
+* The automatic network configuration allows you to log in to Workbench from a browser _running on the same host as Docker_. Connecting from other hosts requires additional configuration (not covered here).
+* Your data will be stored inside the Docker containers. You may stop and restart the containers without loss, but if you delete the container, your data will be gone.
+* Updating the Arvados software inside the Docker containers is not supported. You may download updated Docker images, but migrating data to updated containers is not yet supported.
{% include 'notebox_end' %}
-First, make sure that @curl@ and @docker@ are installed on your system, and that you are in the docker group (see "Installing Docker":https://docs.docker.com/installation/).
+h2. Prerequisites
+
+# A GNU/Linux x64 (virtual) machine
+# A working Docker installation (see "Installing Docker":https://docs.docker.com/installation/)
+# curl
+
+h2. Verify prerequisites
+
+Make sure that @curl@ and @docker@ are installed on your system, and that you are in the docker group (see "Installing Docker":https://docs.docker.com/installation/).
~$ which curl
/usr/bin/curl
@@ -21,12 +35,41 @@ Docker version 1.2.0-dev, build dc243c8
yourusername sudo fuse docker
~$ \curl -sSL get.arvados.org | bash
+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. -If you prefer, you can also download the installation script and inspect it before running it. @get.arvados.org@ redirects to "https://raw.githubusercontent.com/curoverse/arvados-dev/master/install/easy-docker-install.sh":https://raw.githubusercontent.com/curoverse/arvados-dev/master/install/easy-docker-install.sh, which is the installation script. +./arvdock test [testname] [testname] ... + By default, all tests are run. +