X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/44c95f99098fa6c6acbfa82d4b6cbc6015eb6e39..refs/heads/21654-docker-upgrade:/doc/install/arvbox.html.textile.liquid
diff --git a/doc/install/arvbox.html.textile.liquid b/doc/install/arvbox.html.textile.liquid
index 8827cf8abf..20e1c48eee 100644
--- a/doc/install/arvbox.html.textile.liquid
+++ b/doc/install/arvbox.html.textile.liquid
@@ -11,54 +11,99 @@ SPDX-License-Identifier: CC-BY-SA-3.0
Arvbox is a Docker-based self-contained development, demonstration and testing environment for Arvados. It is not intended for production use.
+h2. Requirements
+
+* Linux 3.x+ and Docker 1.10+
+* Minimum of 4 GiB of RAM + additional memory to run jobs
+* Minimum of 4 GiB of disk + storage for actual data
+
h2. Quick start
+{% include 'branchname' %}
+
+
+$ curl -O https://git.arvados.org/arvados.git/blob_plain/refs/heads/{{branchname}}:/tools/arvbox/bin/arvbox
+$ chmod +x arvbox
+$ ./arvbox start localdemo
+
+Arvados-in-a-box starting
+
+Waiting for workbench2 websockets workbench webshell keep-web controller keepproxy api keepstore1 arv-git-httpd keepstore0 sdk vm ...
+
+...
+
+Your Arvados-in-a-box is ready!
+
+$ ./arvbox adduser demouser demo@example.com
+Password for demouser:
+Added demouser
+
-$ git clone https://github.com/curoverse/arvados.git -$ cd arvados/tools/arvbox/bin -$ ./arvbox start localdemo +$ ./arvbox root-cert +Certificate copied to /home/ubuntu/arvbox-root-cert.crt-h2. Requirements +{% assign ca_cert_name = 'arvbox-root-cert.crt' %} -* Linux 3.x+ and Docker 1.9+ -* Minimum of 3 GiB of RAM + additional memory to run jobs -* Minimum of 3 GiB of disk + storage for actual data +{% include 'install_ca_cert' %} h2. Usage
$ arvbox -Arvados-in-a-box http://arvados.org - -buildh2. Configs h3. dev -Development configuration. Boots a complete Arvados environment inside the container. The "arvados", "arvado-dev" and "sso-devise-omniauth-provider" code directories along data directories "postgres", "var", "passenger" and "gems" are bind mounted from the host file system for easy access and persistence across container rebuilds. Services are bound to the Docker container's network IP address and can only be accessed on the local host. +Development configuration. Boots a complete Arvados environment inside the container. The "arvados" and "arvados-dev" code directories along data directories "postgres", "var", "passenger" and "gems" are bind mounted from the host file system for easy access and persistence across container rebuilds. Services are bound to the Docker container's network IP address and can only be accessed on the local host. -In "dev" mode, you can override the default autogenerated settings of Rails projects by adding "application.yml.override" to any Rails project (sso, api, workbench). This can be used to test out API server settings or point Workbench at an alternate API server. +In "dev" mode, you can override the default autogenerated settings of Rails projects by adding "application.yml.override" to any Rails project (api, workbench). This can be used to test out API server settings or point Workbench at an alternate API server. h3. localdemo @@ -66,7 +111,11 @@ Demo configuration. Boots a complete Arvados environment inside the container. h3. test -Run the test suite. +Starts postgres and initializes the API server, then runs the Arvados test suite. Will pass command line arguments to test runner. Supports test runner interactive mode. + +h3. devenv + +Starts a minimal container with no services and the host's $HOME bind mounted inside the container, then enters an interactive login shell. Intended to make it convenient to use tools installed in arvbox that don't require services. h3. publicdev @@ -108,11 +157,6 @@ h3. ARVADOS_DEV_ROOT The root directory of the Arvados-dev source tree default: $ARVBOX_DATA/arvados-dev -h3. SSO_ROOT - -The root directory of the SSO source tree -default: $ARVBOX_DATA/sso-devise-omniauth-provider - h3. ARVBOX_PUBLISH_IP The IP address on which to publish services when running in public configuration. Overrides default detection of the host's IP address.build arvbox Docker image -rebuild build arvbox Docker image, no layer cache -start|run start arvbox container -open open arvbox workbench in a web browser -shell enter arvbox shell -ip print arvbox docker container ip address -host print arvbox published host -status print some information about current arvbox -stop stop arvbox container -restart stop, then run again -reboot stop, build arvbox Docker image, run -reset delete arvbox arvados data (be careful!) -destroy delete all arvbox code and data (be careful!) -log tail log of specified service -ls list directories inside arvbox -cat get contents of files inside arvbox -pipe run a bash script piped in from stdin -sv change state of service inside arvbox -clone clone an arvbox +Arvados-in-a-box https://doc.arvados.org/install/arvbox.html + +start|run [tag] start arvbox container +stop stop arvbox container +restart stop, then run again +status print some information about current arvbox +ip print arvbox docker container ip address +host print arvbox published host +shell enter shell as root +ashell enter shell as 'arvbox' +psql enter postgres console +open open arvbox workbench in a web browser +root-cert get copy of root certificate +update stop, pull latest image, run +build build arvbox Docker image +reboot stop, build arvbox Docker image, run +rebuild build arvbox Docker image, no layer cache +checkpoint create database backup +restore restore checkpoint +hotreset reset database and restart API without restarting container +reset delete arvbox arvados data (be careful!) +destroy delete all arvbox code and data (be careful!) +log tail log of specified service +ls list directories inside arvbox +cat get contents of files inside arvbox +pipe run a bash script piped in from stdin +sv + change state of service inside arvbox +clone clone dev arvbox +adduser [password] + add a user login +removeuser + remove user login +listusers list user logins