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
77 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#aws.
80 <pre><code> Containers:
82 ImageID: <span class="userinput">ami-01234567890abcdef</span>
85 # If you are not using an IAM role for authentication, specify access
86 # credentials here. Otherwise, omit or set AccessKeyID and
87 # SecretAccessKey to an empty value.
88 AccessKeyID: XXXXXXXXXXXXXXXXXXXX
89 SecretAccessKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
93 SubnetID: subnet-0123abcd
96 AdminUsername: arvados
100 h4. Minimal configuration example for Azure
104 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#azure.
107 <pre><code> Containers:
109 ImageID: <span class="userinput">"zzzzz-compute-v1597349873"</span>
111 # (azure) managed disks: set MaxConcurrentInstanceCreateOps to 20 to avoid timeouts, cf
112 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
113 MaxConcurrentInstanceCreateOps: 20
116 SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
117 ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
118 ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
119 TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
121 # Data center where VMs will be allocated
124 # The resource group where the VM and virtual NIC will be
127 NetworkResourceGroup: yyyyy # only if different from ResourceGroup
129 Subnet: xxxxx-subnet-private
131 # The resource group where the disk image is stored, only needs to
132 # be specified if it is different from ResourceGroup
133 ImageResourceGroup: aaaaa
138 Azure recommends using managed images. If you plan to start more than 20 VMs simultaneously, Azure recommends using a shared image gallery instead to avoid slowdowns and timeouts during the creation of the VMs.
140 Using an image from a shared image gallery:
143 <pre><code> Containers:
145 ImageID: <span class="userinput">"shared_image_gallery_image_definition_name"</span>
149 SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
150 ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
151 ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
152 TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
154 # Data center where VMs will be allocated
157 # The resource group where the VM and virtual NIC will be
160 NetworkResourceGroup: yyyyy # only if different from ResourceGroup
162 Subnet: xxxxx-subnet-private
164 # The resource group where the disk image is stored, only needs to
165 # be specified if it is different from ResourceGroup
166 ImageResourceGroup: aaaaa
168 # (azure) shared image gallery: the name of the gallery
169 SharedImageGalleryName: "shared_image_gallery_1"
170 # (azure) shared image gallery: the version of the image definition
171 SharedImageGalleryImageVersion: "0.0.1"
176 Using unmanaged disks (deprecated):
178 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#azure.
181 <pre><code> Containers:
183 ImageID: <span class="userinput">"https://zzzzzzzz.blob.core.windows.net/system/Microsoft.Compute/Images/images/zzzzz-compute-osDisk.55555555-5555-5555-5555-555555555555.vhd"</span>
187 SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
188 ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
189 ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
190 TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
192 # Data center where VMs will be allocated
195 # The resource group where the VM and virtual NIC will be
198 NetworkResourceGroup: yyyyy # only if different from ResourceGroup
200 Subnet: xxxxx-subnet-private
202 # Where to store the VM VHD blobs
203 StorageAccount: example
209 Get the @SubscriptionID@ and @TenantID@:
215 "cloudName": "AzureCloud",
216 "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX",
218 "name": "Your Subscription",
220 "tenantId": "YYYYYYYY-YYYY-YYYY-YYYYYYYY",
222 "name": "you@example.com",
229 You will need to create a "service principal" to use as a delegated authority for API access.
231 <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>
232 $ az ad sp create "<span class="userinput">appId</span>"
233 (appId is part of the response of the previous command)
234 $ az role assignment create --assignee "<span class="userinput">objectId</span>" --role Owner --scope /subscriptions/{subscriptionId}/
235 (objectId is part of the response of the previous command)
236 </code></pre></notextile>
238 Now update your @config.yml@ file:
240 @ClientID@ is the 'appId' value.
242 @ClientSecret@ is what was provided as <span class="userinput">Your_Password</span>.
244 h3. Test your configuration
246 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.
249 <pre><code>~$ <span class="userinput">arvados-server cloudtest && echo "OK!"</span>
253 Refer to the "cloudtest tool documentation":../../admin/cloudtest.html for more information.
255 {% assign arvados_component = 'arvados-dispatch-cloud' %}
257 {% include 'install_packages' %}
259 {% include 'start_service' %}
261 {% include 'restart_api' %}
263 h2(#confirm-working). Confirm working installation
265 On the dispatch node, start monitoring the arvados-dispatch-cloud logs:
268 <pre><code>~$ <span class="userinput">sudo journalctl -o cat -fu arvados-dispatch-cloud.service</span>
272 "Make sure to install the arvados/jobs image.":../install-jobs-image.html
274 Submit a simple container request:
277 <pre><code>shell:~$ <span class="userinput">arv container_request create --container-request '{
279 "state": "Committed",
281 "container_image": "arvados/jobs:latest",
282 "command": ["echo", "Hello, Crunch!"],
283 "output_path": "/out",
290 "runtime_constraints": {
298 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.
300 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:
303 <pre><code>~$ <span class="userinput">curl -sH "Authorization: Bearer $token" http://localhost:9006/arvados/v1/dispatch/containers</span>
308 "uuid": "zzzzz-dz642-hdp2vpu9nq14tx0",
311 "scheduling_parameters": {
313 "preemptible": false,
317 "runtime_status": null,
322 "Name": "Standard_D2s_v3",
323 "ProviderType": "Standard_D2s_v3",
326 "Scratch": 16000000000,
327 "IncludedScratch": 16000000000,
338 A similar request can be made to the @http://localhost:9006/arvados/v1/dispatch/instances@ endpoint.
340 When the container finishes, the dispatcher will log it.
342 After the container finishes, you can get the container record by UUID *from a shell server* to see its results:
345 <pre><code>shell:~$ <span class="userinput">arv get <b>zzzzz-dz642-hdp2vpu9nq14tx0</b></span>
349 "log":"a01df2f7e5bc1c2ad59c60a837e90dc6+166",
350 "output":"d41d8cd98f00b204e9800998ecf8427e+0",
357 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:
360 <pre><code>~$ <span class="userinput">arv keep ls <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b></span>
364 ~$ <span class="userinput">arv-get <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b>/stdout.txt</span>
365 2016-08-05T13:53:06.201011Z Hello, Crunch!
369 If the container does not dispatch successfully, refer to the @arvados-dispatch-cloud@ logs for information about why it failed.