[ARVADOS-DEV] created: c58bb03309b865985296df24108f92de8bae3020

[git at public.curoverse.com]

        at  c58bb03309b865985296df24108f92de8bae3020 (commit)


commit c58bb03309b865985296df24108f92de8bae3020
Author: Peter Amstutz <peter.amstutz at curoverse.com>
Date:   Mon Jan 25 14:41:05 2016 -0500

    Add some examples of using arvbox.

diff --git a/arvbox/README.md b/arvbox/README.md
index 9ced1d1..2ac36c9 100644
--- a/arvbox/README.md
+++ b/arvbox/README.md
@@ -5,9 +5,16 @@ Self-contained development, demonstration and testing environment for Arvados.
 ## Quick start
 
 ```
-$ bin/arvbox reboot localdemo
+$ arvbox reboot localdemo
 ```
 
+## Requirements
+
+* Linux 3.x+ and Docker 1.9+
+* Minimum of  4 GiB  RAM,  recommend  8+ GiB
+* Minimum of 10 GiB  disk, recommend 40+ GiB
+* Minimum of  2 CPU cores, recommend  4+ cores
+
 ## Usage
 
 ```
@@ -30,11 +37,63 @@ svrestart <service> restart specified service inside arvbox
 clone <from> <to>   clone an arvbox
 ```
 
-## Requirements
+## Example uses cases
 
-* 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
+### Arvados Workbench development
+
+First start a `dev` container:
+
+```
+$ arvbox reboot dev
+
+Arvados-in-a-box starting
+
+...
+
+Your Arvados-in-a-box is ready!
+Workbench is running at http://172.17.0.2
+
+export ARVADOS_API_HOST=172.17.0.2:8000
+The Arvados source code is checked out at: ~/.arvbox/arvbox/arvados
+```
+
+Then go to the Arvados source directory:
+
+```
+$ cd ~/.arvbox/arvbox/arvados/apps/workbench
+```
+
+### Run the Arvados test suite
+
+Run the entire test suite:
+
+```
+$ arvbox restart testa
+```
+
+Test a single component:
+
+```
+$ arvbox restart test --only sdk/python
+```
+
+### Run Arvados demo on a cloud compute node
+
+Allocate a compute node on your favorite cloud provider using a recent Linux
+distribution.  Recommend
+
+```
+$ ARVBOX_PUBLISH_IP=*node.public.hostname* arvbox reboot publicdemo
+
+Arvados-in-a-box starting
+
+...
+
+Your Arvados-in-a-box is ready!
+Workbench is running at http://node.public.hostname
+
+export ARVADOS_API_HOST=node.public.hostname:8000
+```
 
 ## Configs
 

-----------------------------------------------------------------------


hooks/post-receive
--