X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/710a784b64e6192770d42a5a27c8f7b167905f4a..feb290061b91fa059aefd251ed3c3532b32620ea:/doc/install/arvbox.html.textile.liquid diff --git a/doc/install/arvbox.html.textile.liquid b/doc/install/arvbox.html.textile.liquid index 2d94d32ac5..3fbd33928a 100644 --- a/doc/install/arvbox.html.textile.liquid +++ b/doc/install/arvbox.html.textile.liquid @@ -14,7 +14,7 @@ Arvbox is a Docker-based self-contained development, demonstration and testing e h2. Quick start
-$ git clone https://github.com/curoverse/arvados.git +$ git clone https://github.com/arvados/arvados.git $ cd arvados/tools/arvbox/bin $ ./arvbox start localdemo@@ -29,29 +29,32 @@ h2. Usage
$ arvbox -Arvados-in-a-box http://arvados.org - -start|runh2. Install root certificate @@ -85,7 +88,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[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 arvbox shell -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 -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 +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