3 navsection: installguide
4 title: Install the cloud dispatcher
7 Copyright (C) The Arvados Authors. All rights reserved.
9 SPDX-License-Identifier: CC-BY-SA-3.0
12 {% include 'notebox_begin_warning' %}
13 arvados-dispatch-cloud is only relevant for cloud installations. Skip this section if you are installing an on premises cluster that will spool jobs to Slurm.
14 {% include 'notebox_end' %}
16 # "Introduction":#introduction
17 # "Create compute node VM image":#create-image
18 # "Update config.yml":#update-config
19 # "Install arvados-dispatch-cloud":#install-packages
20 # "Start the service":#start-service
21 # "Restart the API server and controller":#restart-api
22 # "Confirm working installation":#confirm-working
24 h2(#introduction). Introduction
26 The cloud dispatch service is for running containers on cloud VMs. It works with Microsoft Azure and Amazon EC2; future versions will also support Google Compute Engine.
28 The cloud dispatch service can run on any node that can connect to the Arvados API service, the cloud provider's API, and the SSH service on cloud VMs. It is not resource-intensive, so you can run it on the API server node.
30 h2(#update-config). Update config.yml
32 h3. Configure CloudVMs
34 Add or update the following portions of your cluster configuration file, @config.yml@. Refer to "config.defaults.yml":{{site.baseurl}}/admin/config.html for information about additional configuration options. The @DispatchPrivateKey@ should be the *private* key generated in "the previous section":install-compute-node.html#sshkeypair.
40 "http://localhost:9006": {}
43 # BootProbeCommand is a shell command that succeeds when an instance is ready for service
44 BootProbeCommand: "sudo systemctl status docker"
46 <b># --- driver-specific configuration goes here --- see Amazon and Azure examples below ---</b>
49 -----BEGIN RSA PRIVATE KEY-----
50 MIIEpQIBAAKCAQEAqXoCzcOBkFQ7w4dvXf9B++1ctgZRqEbgRYL3SstuMV4oawks
51 ttUuxJycDdsPmeYcHsKo8vsEZpN6iYsX6ZZzhkO5nEayUTU8sBjmg1ZCTo4QqKXr
52 FJ+amZ7oYMDof6QEdwl6KNDfIddL+NfBCLQTVInOAaNss7GRrxLTuTV7HcRaIUUI
53 jYg0Ibg8ZZTzQxCvFXXnjseTgmOcTv7CuuGdt91OVdoq8czG/w8TwOhymEb7mQlt
54 lXuucwQvYgfoUgcnTgpJr7j+hafp75g2wlPozp8gJ6WQ2yBWcfqL2aw7m7Ll88Nd
56 oFyAjVoexx0RBcH6BveTfQtJKbktP1qBO4mXo2dP0cacuZEtlAqW9Eb06Pvaw/D9
57 foktmqOY8MyctzFgXBpGTxPliGjqo8OkrOyQP2g+FL7v+Km31Xs61P8=
58 -----END RSA PRIVATE KEY-----
61 ProviderType: x1.medium
67 ProviderType: x1.large
70 IncludedScratch: 128GB
75 h4. Minimal configuration example for Amazon EC2
78 <pre><code> Containers:
80 ImageID: ami-01234567890abcdef
83 AccessKeyID: XXXXXXXXXXXXXXXXXXXX
84 SecretAccessKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
87 SubnetID: subnet-0123abcd
90 AdminUsername: arvados
94 h4. Minimal configuration example for Azure
97 <pre><code> Containers:
99 ImageID: "https://zzzzzzzz.blob.core.windows.net/system/Microsoft.Compute/Images/images/zzzzz-compute-osDisk.55555555-5555-5555-5555-555555555555.vhd"
103 SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
104 ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
105 ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
106 TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
108 # Data center where VMs will be allocated
111 # The resource group where the VM and virtual NIC will be
114 NetworkResourceGroup: yyyyy # only if different from ResourceGroup
116 Subnet: xxxxx-subnet-private
118 # Where to store the VM VHD blobs
119 StorageAccount: example
125 Get the @SubscriptionID@ and @TenantID@:
131 "cloudName": "AzureCloud",
132 "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX",
134 "name": "Your Subscription",
136 "tenantId": "YYYYYYYY-YYYY-YYYY-YYYYYYYY",
138 "name": "you@example.com",
145 You will need to create a "service principal" to use as a delegated authority for API access.
147 <notextile><pre><code>$ az ad app create --display-name "Arvados Dispatch Cloud (<span class="userinput">ClusterID</span>)" --homepage "https://arvados.org" --identifier-uris "https://<span class="userinput">ClusterID.example.com</span>" --end-date 2299-12-31 --password <span class="userinput">Your_Password</span>
148 $ az ad sp create "<span class="userinput">appId</span>"
149 (appId is part of the response of the previous command)
150 $ az role assignment create --assignee "<span class="userinput">objectId</span>" --role Owner --scope /subscriptions/{subscriptionId}/
151 (objectId is part of the response of the previous command)
152 </code></pre></notextile>
154 Now update your @config.yml@ file:
156 @ClientID@ is the 'appId' value.
158 @ClientSecret@ is what was provided as <span class="userinput">Your_Password</span>.
160 h3. Test your configuration
162 Run the @cloudtest@ tool to verify that your configuration works. This creates a new cloud VM, confirms that it boots correctly and accepts your configured SSH private key, and shuts it down.
165 <pre><code>~$ <span class="userinput">arvados-server cloudtest && echo "OK!"</span>
169 Refer to the "cloudtest tool documentation":../../admin/cloudtest.html for more information.
171 {% assign arvados_component = 'arvados-dispatch-cloud' %}
173 {% include 'install_packages' %}
175 {% include 'start_service' %}
177 {% include 'restart_api' %}
179 h2(#confirm-working). Confirm working installation
181 On the dispatch node, start monitoring the arvados-dispatch-cloud logs:
184 <pre><code>~$ <span class="userinput">sudo journalctl -o cat -fu arvados-dispatch-cloud.service</span>
188 "Make sure to install the arvados/jobs image.":../install-jobs-image.html
190 Submit a simple container request:
193 <pre><code>shell:~$ <span class="userinput">arv container_request create --container-request '{
195 "state": "Committed",
197 "container_image": "arvados/jobs:latest",
198 "command": ["echo", "Hello, Crunch!"],
199 "output_path": "/out",
206 "runtime_constraints": {
214 This command should return a record with a @container_uuid@ field. Once @arvados-dispatch-cloud@ polls the API server for new containers to run, you should see it dispatch that same container.
216 The @arvados-dispatch-cloud@ API provides a list of queued and running jobs and cloud instances. Use your @ManagementToken@ to test the dispatcher's endpoint. For example, when one container is running:
219 <pre><code>~$ <span class="userinput">curl -sH "Authorization: Bearer $token" http://localhost:9006/arvados/v1/dispatch/containers</span>
224 "uuid": "zzzzz-dz642-hdp2vpu9nq14tx0",
227 "scheduling_parameters": {
229 "preemptible": false,
233 "runtime_status": null,
238 "Name": "Standard_D2s_v3",
239 "ProviderType": "Standard_D2s_v3",
242 "Scratch": 16000000000,
243 "IncludedScratch": 16000000000,
254 A similar request can be made to the @http://localhost:9006/arvados/v1/dispatch/instances@ endpoint.
256 When the container finishes, the dispatcher will log it.
258 After the container finishes, you can get the container record by UUID *from a shell server* to see its results:
261 <pre><code>shell:~$ <span class="userinput">arv get <b>zzzzz-dz642-hdp2vpu9nq14tx0</b></span>
265 "log":"a01df2f7e5bc1c2ad59c60a837e90dc6+166",
266 "output":"d41d8cd98f00b204e9800998ecf8427e+0",
273 You can use standard Keep tools to view the container's output and logs from their corresponding fields. For example, to see the logs from the collection referenced in the @log@ field:
276 <pre><code>~$ <span class="userinput">arv keep ls <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b></span>
280 ~$ <span class="userinput">arv-get <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b>/stdout.txt</span>
281 2016-08-05T13:53:06.201011Z Hello, Crunch!
285 If the container does not dispatch successfully, refer to the @arvados-dispatch-cloud@ logs for information about why it failed.