Cloudtest utility » History » Version 1

Tom Clegg, 06/25/2019 07:21 PM

1 1 Tom Clegg
h1. Cloudtest utility
2 1 Tom Clegg
3 1 Tom Clegg
The @arvados-server@ package provides a @cloudtest@ tool that checks compatibility between your Arvados configuration, your cloud driver, your cloud provider's API, your cloud provider's VM instances, and the worker image you use for [[Dispatching containers to cloud VMs]].
4 1 Tom Clegg
5 1 Tom Clegg
@arvados-server cloudtest@ performs the following sequence:
6 1 Tom Clegg
# Create a new instance
7 1 Tom Clegg
# Wait for it to finish booting
8 1 Tom Clegg
# Run a shell command on the new instance (optional)
9 1 Tom Clegg
# Pause while you log in to the new instance and do other tests yourself (optional)
10 1 Tom Clegg
# Shut down the instance
11 1 Tom Clegg
12 1 Tom Clegg
This is meant to be a convenient way to expose problems like these:
13 1 Tom Clegg
* Configured credentials don't work
14 1 Tom Clegg
* Configured image types don't work
15 1 Tom Clegg
* Configured driver is not compatible with your cloud API/region
16 1 Tom Clegg
* Newly created instances are not usable due to a network problem or misconfiguration
17 1 Tom Clegg
* Selected machine image does not boot properly
18 1 Tom Clegg
* Selected machine image is incompatible with some instance types
19 1 Tom Clegg
* Driver has bugs
20 1 Tom Clegg
21 1 Tom Clegg
Before bringing up the arvados-dispatch-cloud service for the first time, we recommend running cloudtest to check your configuration:
22 1 Tom Clegg
<pre>
23 1 Tom Clegg
$ arvados-server cloudtest -command "crunch-run --list"
24 1 Tom Clegg
</pre>
25 1 Tom Clegg
26 1 Tom Clegg
Before updating your configuration with a new VM image, we recommend running cloudtest with the new image
27 1 Tom Clegg
<pre>
28 1 Tom Clegg
$ arvados-server cloudtest -image-id $new_image_id -command "crunch-run --list"
29 1 Tom Clegg
</pre>
30 1 Tom Clegg
31 1 Tom Clegg
After adding an instance type to your configuration, we recommend testing your image with the new instance type:
32 1 Tom Clegg
<pre>
33 1 Tom Clegg
$ arvados-server cloudtest -instance-type $new_instance_type_name
34 1 Tom Clegg
</pre>
35 1 Tom Clegg
36 1 Tom Clegg
For a list of additional options, use the @-help@ flag:
37 1 Tom Clegg
<pre>
38 1 Tom Clegg
$ arvados-server cloudtest -help
39 1 Tom Clegg
Usage:
40 1 Tom Clegg
  -command string
41 1 Tom Clegg
        Run an interactive shell command on the test instance when it boots
42 1 Tom Clegg
  -config file
43 1 Tom Clegg
        Site configuration file (default "/etc/arvados/config.yml")
44 1 Tom Clegg
  -destroy-existing
45 1 Tom Clegg
        Destroy any existing instances tagged with our InstanceSetID, instead of erroring out
46 1 Tom Clegg
  -image-id string
47 1 Tom Clegg
        Image ID to use when creating the test instance (if empty, use cluster config)
48 1 Tom Clegg
  -instance-set-id value
49 1 Tom Clegg
        InstanceSetID tag value to use on the test instance (default "cloudtest-user@hostname.example")
50 1 Tom Clegg
  -instance-type string
51 1 Tom Clegg
        Instance type to create (if empty, use cheapest type in config)
52 1 Tom Clegg
  -pause-before-destroy
53 1 Tom Clegg
        Prompt and wait before destroying the test instance
54 1 Tom Clegg
</pre>