Arvbox » History » Version 11

Peter Amstutz, 03/03/2016 05:14 PM

1 1 Peter Amstutz
h1. Arvbox
2 1 Peter Amstutz
3 3 Peter Amstutz
We recommend using "Arvbox":http://doc.arvados.org/install/arvbox.html to set up self-contained Arvados development environment.
4 1 Peter Amstutz
5 3 Peter Amstutz
h2. Running Arvados in development mode
6 3 Peter Amstutz
7 3 Peter Amstutz
<pre>
8 3 Peter Amstutz
$ arvbox reboot dev
9 3 Peter Amstutz
</pre>
10 3 Peter Amstutz
11 3 Peter Amstutz
This performs the following operations:
12 3 Peter Amstutz
13 3 Peter Amstutz
# Rebuild the arvbox-dev docker image (typically the layers are cached so this is a no-op unless you are working on arvbox itself)
14 3 Peter Amstutz
# Create @~/.arvbox/arvbox@ to store arvbox state
15 3 Peter Amstutz
# Clone the arvados git repository to @~/.arvbox/arvbox/arvados@
16 3 Peter Amstutz
# Place stateful container data in @~/.arvbox/arvbox/postgres@ and @~/.arvbox/arvbox/var@
17 3 Peter Amstutz
# Start the container
18 3 Peter Amstutz
19 3 Peter Amstutz
The container will then:
20 3 Peter Amstutz
# Download and cache various packages (Ruby gems, Passenger)
21 5 Peter Amstutz
# Compile and install Arvados server binaries
22 5 Peter Amstutz
# Build and install Arvados SDK packages (such as arvados-python-client)
23 3 Peter Amstutz
# Start the Arvados services
24 3 Peter Amstutz
25 3 Peter Amstutz
The directories inside @~/.arvbox/arvbox@ are all bind-mounted inside the container.  This means that you may edit files on the host file system and the changes will be seen inside the container immediately.  For example, if you edit a page template in @~/.arvbox/arvbox/arvados/apps/workbench/app/views@ you only need to reload the page in your browser to see the change.
26 3 Peter Amstutz
27 6 Peter Amstutz
You can restart individual services without restarting the whole container.  For compiled services, the startup script always recompiles the server before starting it.  For example, if you are working on @keepproxy@
28 3 Peter Amstutz
29 3 Peter Amstutz
<pre>
30 3 Peter Amstutz
$ arvbox sv restart keepproxy
31 3 Peter Amstutz
</pre>
32 3 Peter Amstutz
33 3 Peter Amstutz
If any service fails to come up, you can see the debug log using @arvbox log@.  This log will include compilation or install errors:
34 3 Peter Amstutz
35 3 Peter Amstutz
<pre>
36 3 Peter Amstutz
$ arvbox log keepproxy
37 3 Peter Amstutz
</pre>
38 3 Peter Amstutz
39 3 Peter Amstutz
Finally, you can get a root shell inside the container using @arvbox sh@
40 3 Peter Amstutz
41 3 Peter Amstutz
<pre>
42 3 Peter Amstutz
$ arvbox sh
43 3 Peter Amstutz
</pre>
44 3 Peter Amstutz
45 11 Peter Amstutz
h2. Making Arvbox accessible from other hosts
46 11 Peter Amstutz
47 11 Peter Amstutz
By default, Arvbox can only be accessed on the same host it is running.  To publish Arvbox service ports to the host's service ports and advertise the host's IP address for services, use @publicdev@ or @publicdemo@:
48 11 Peter Amstutz
49 11 Peter Amstutz
<pre>
50 11 Peter Amstutz
$ arvbox reboot publicdev
51 11 Peter Amstutz
</pre>
52 11 Peter Amstutz
53 11 Peter Amstutz
This attempts to auto-detect the correct IP address to use by taking the IP address of the default route device.  If the auto-detection is wrong, you want to publish a hostname instead of a raw address, or you need to publish a different public-facing device (such as a router or firewall), set @ARVBOX_PUBLISH_IP@ to the desire hostname or IP address.
54 11 Peter Amstutz
55 11 Peter Amstutz
<pre>
56 11 Peter Amstutz
$ export ARVBOX_PUBLISH_IP=example.com
57 11 Peter Amstutz
$ arvbox reboot publicdev
58 11 Peter Amstutz
</pre>
59 11 Peter Amstutz
60 11 Peter Amstutz
Note: this expects to bind the host's port 80 (http) for workbench, so you cannot have a conflicting web server already running on the host.  It does not attempt to take bind the host's port 22 (ssh), as a result the arvbox ssh port is not published.
61 11 Peter Amstutz
62 9 Peter Amstutz
h2. Running multiple Arvbox containers
63 9 Peter Amstutz
64 9 Peter Amstutz
To run multiple Arvbox containers, give them different names by setting the environment variable @ARVBOX_CONTAINER@.
65 9 Peter Amstutz
66 9 Peter Amstutz
<pre>
67 9 Peter Amstutz
$ arvbox status
68 9 Peter Amstutz
Selected: arvbox
69 9 Peter Amstutz
Status: running
70 9 Peter Amstutz
IP: 172.17.0.2
71 9 Peter Amstutz
Data: /home/peter/.arvbox/arvbox
72 9 Peter Amstutz
73 9 Peter Amstutz
$ export ARVBOX_CONTAINER=arvbox2
74 9 Peter Amstutz
$ arvbox status
75 9 Peter Amstutz
Selected: arvbox2
76 9 Peter Amstutz
Status: not running
77 9 Peter Amstutz
Data: /home/peter/.arvbox/arvbox2
78 9 Peter Amstutz
</pre>
79 9 Peter Amstutz
80 3 Peter Amstutz
h2. Running the test suite
81 1 Peter Amstutz
82 9 Peter Amstutz
Arvbox can also be used to run the Arvados test suite in an isolated environment.
83 3 Peter Amstutz
84 3 Peter Amstutz
<pre>
85 3 Peter Amstutz
$ arvbox restart test
86 3 Peter Amstutz
</pre>
87 7 Peter Amstutz
88 8 Peter Amstutz
You can pass parameters to the test suite as described in [[Running tests#Save-time-by-skipping-install]]:
89 7 Peter Amstutz
90 7 Peter Amstutz
<pre>
91 7 Peter Amstutz
$ arvbox restart test --only services/keepproxy
92 7 Peter Amstutz
</pre>