Merge branch '19054-local-keepstore-aws-doc-update'
[arvados.git] / doc / install / crunch2-cloud / install-dispatch-cloud.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Install the cloud dispatcher
5 ...
6 {% comment %}
7 Copyright (C) The Arvados Authors. All rights reserved.
8
9 SPDX-License-Identifier: CC-BY-SA-3.0
10 {% endcomment %}
11
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 or LSF.
14 {% include 'notebox_end' %}
15
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
23
24 h2(#introduction). Introduction
25
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.
27
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.
29
30 More detail about the internal operation of the dispatcher can be found in the "architecture section":{{site.baseurl}}/architecture/dispatchcloud.html.
31
32 h2(#update-config). Update config.yml
33
34 h3. Configure CloudVMs
35
36 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.
37
38 <notextile>
39 <pre><code>    Services:
40       DispatchCloud:
41         InternalURLs:
42           "http://localhost:9006": {}
43     Containers:
44       CloudVMs:
45         # BootProbeCommand is a shell command that succeeds when an instance is ready for service
46         BootProbeCommand: "sudo systemctl status docker"
47
48         <b># --- driver-specific configuration goes here --- see Amazon and Azure examples below ---</b>
49
50       DispatchPrivateKey: |
51         -----BEGIN RSA PRIVATE KEY-----
52         MIIEpQIBAAKCAQEAqXoCzcOBkFQ7w4dvXf9B++1ctgZRqEbgRYL3SstuMV4oawks
53         ttUuxJycDdsPmeYcHsKo8vsEZpN6iYsX6ZZzhkO5nEayUTU8sBjmg1ZCTo4QqKXr
54         FJ+amZ7oYMDof6QEdwl6KNDfIddL+NfBCLQTVInOAaNss7GRrxLTuTV7HcRaIUUI
55         jYg0Ibg8ZZTzQxCvFXXnjseTgmOcTv7CuuGdt91OVdoq8czG/w8TwOhymEb7mQlt
56         lXuucwQvYgfoUgcnTgpJr7j+hafp75g2wlPozp8gJ6WQ2yBWcfqL2aw7m7Ll88Nd
57         [...]
58         oFyAjVoexx0RBcH6BveTfQtJKbktP1qBO4mXo2dP0cacuZEtlAqW9Eb06Pvaw/D9
59         foktmqOY8MyctzFgXBpGTxPliGjqo8OkrOyQP2g+FL7v+Km31Xs61P8=
60         -----END RSA PRIVATE KEY-----
61     InstanceTypes:
62       x1md:
63         ProviderType: x1.medium
64         VCPUs: 8
65         RAM: 64GiB
66         IncludedScratch: 64GB
67         Price: 0.62
68       x1lg:
69         ProviderType: x1.large
70         VCPUs: 16
71         RAM: 128GiB
72         IncludedScratch: 128GB
73         Price: 1.23
74 </code></pre>
75 </notextile>
76
77 h3(#GPUsupport). NVIDIA GPU support
78
79 To specify instance types with NVIDIA GPUs, you must include an additional @CUDA@ section:
80
81 <notextile>
82 <pre><code>    InstanceTypes:
83       g4dn:
84         ProviderType: g4dn.xlarge
85         VCPUs: 4
86         RAM: 16GiB
87         IncludedScratch: 125GB
88         Price: 0.56
89         CUDA:
90           DriverVersion: "11.4"
91           HardwareCapability: "7.5"
92           DeviceCount: 1
93 </code></pre>
94 </notextile>
95
96 The @DriverVersion@ is the version of the CUDA toolkit installed in your compute image (in X.Y format, do not include the patchlevel).  The @HardwareCapability@ is the CUDA compute capability of the GPUs available for this instance type.  The @DeviceCount@ is the number of GPU cores available for this instance type.
97
98 h3. AWS Credentials for Local Keepstore on Compute node
99
100 When @Containers/LocalKeepBlobBuffersPerVCPU@ is non-zero, the compute node will spin up a local Keepstore service for faster storage access. If Keep is backed by S3, the compute node will need to be able to access the S3 bucket.
101
102 If the AWS credentials for S3 access are configured in @config.yml@ (i.e. @Volumes/DriverParameters/AccessKeyID@ and @Volumes/DriverParameters/SecretAccessKey@), these credentials will be made available to the local Keepstore on the compute node to access S3 directly and no further configuration is necessary.
103
104 Alternatively, if an IAM role is configured in @config.yml@ (i.e. @Volumes/DriverParameters/IAMRole@), the name of an instance profile that corresponds to this role ("often identical to the name of the IAM role":https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#ec2-instance-profile) must be configured in the @CloudVMs/DriverParameters/IAMInstanceProfile@ parameter.
105
106 Finally, if @config.yml@ does not have @Volumes/DriverParameters/AccessKeyID@, @Volumes/DriverParameters/SecretAccessKey@ or @Volumes/DriverParameters/IAMRole@ defined, Keepstore uses the IAM role attached to the node, whatever it may be called. The @CloudVMs/DriverParameters/IAMInstanceProfile@ parameter must then still be configured with the name of a profile whose IAM role has permission to access the S3 bucket(s). That way, @arvados-dispatch-cloud@ can attach the IAM role to the compute node as it is created.
107
108 h3. Minimal configuration example for Amazon EC2
109
110 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#aws.
111
112 <notextile>
113 <pre><code>    Containers:
114       CloudVMs:
115         ImageID: <span class="userinput">ami-01234567890abcdef</span>
116         Driver: ec2
117         DriverParameters:
118           # If you are not using an IAM role for authentication, specify access
119           # credentials here. Otherwise, omit or set AccessKeyID and
120           # SecretAccessKey to an empty value.
121           AccessKeyID: XXXXXXXXXXXXXXXXXXXX
122           SecretAccessKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
123
124           SecurityGroupIDs:
125           - sg-0123abcd
126           SubnetID: subnet-0123abcd
127           Region: us-east-1
128           EBSVolumeType: gp2
129           AdminUsername: arvados
130 </code></pre>
131 </notextile>
132
133 Example policy for the IAM role used by the cloud dispatcher:
134
135 <notextile>
136 <pre>
137 {
138     "Version": "2012-10-17",
139     "Id": "arvados-dispatch-cloud policy",
140     "Statement": [
141         {
142             "Effect": "Allow",
143             "Action": [
144                 "iam:PassRole",
145                 "ec2:DescribeKeyPairs",
146                 "ec2:ImportKeyPair",
147                 "ec2:RunInstances",
148                 "ec2:DescribeInstances",
149                 "ec2:CreateTags",
150                 "ec2:TerminateInstances"
151             ],
152             "Resource": "*"
153         }
154     ]
155 }
156 </pre>
157 </notextile>
158
159 h3. Minimal configuration example for Azure
160
161 Using managed disks:
162
163 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#azure.
164
165 <notextile>
166 <pre><code>    Containers:
167       CloudVMs:
168         ImageID: <span class="userinput">"zzzzz-compute-v1597349873"</span>
169         Driver: azure
170         # (azure) managed disks: set MaxConcurrentInstanceCreateOps to 20 to avoid timeouts, cf
171         # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
172         MaxConcurrentInstanceCreateOps: 20
173         DriverParameters:
174           # Credentials.
175           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
176           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
177           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
178           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
179
180           # Data center where VMs will be allocated
181           Location: centralus
182
183           # The resource group where the VM and virtual NIC will be
184           # created.
185           ResourceGroup: zzzzz
186           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
187           Network: xxxxx
188           Subnet: xxxxx-subnet-private
189
190           # The resource group where the disk image is stored, only needs to
191           # be specified if it is different from ResourceGroup
192           ImageResourceGroup: aaaaa
193
194 </code></pre>
195 </notextile>
196
197 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.
198
199 Using an image from a shared image gallery:
200
201 <notextile>
202 <pre><code>    Containers:
203       CloudVMs:
204         ImageID: <span class="userinput">"shared_image_gallery_image_definition_name"</span>
205         Driver: azure
206         DriverParameters:
207           # Credentials.
208           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
209           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
210           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
211           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
212
213           # Data center where VMs will be allocated
214           Location: centralus
215
216           # The resource group where the VM and virtual NIC will be
217           # created.
218           ResourceGroup: zzzzz
219           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
220           Network: xxxxx
221           Subnet: xxxxx-subnet-private
222
223           # The resource group where the disk image is stored, only needs to
224           # be specified if it is different from ResourceGroup
225           ImageResourceGroup: aaaaa
226
227           # (azure) shared image gallery: the name of the gallery
228           SharedImageGalleryName: "shared_image_gallery_1"
229           # (azure) shared image gallery: the version of the image definition
230           SharedImageGalleryImageVersion: "0.0.1"
231
232 </code></pre>
233 </notextile>
234
235 Using unmanaged disks (deprecated):
236
237 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#azure.
238
239 <notextile>
240 <pre><code>    Containers:
241       CloudVMs:
242         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>
243         Driver: azure
244         DriverParameters:
245           # Credentials.
246           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
247           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
248           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
249           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
250
251           # Data center where VMs will be allocated
252           Location: centralus
253
254           # The resource group where the VM and virtual NIC will be
255           # created.
256           ResourceGroup: zzzzz
257           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
258           Network: xxxxx
259           Subnet: xxxxx-subnet-private
260
261           # Where to store the VM VHD blobs
262           StorageAccount: example
263           BlobContainer: vhds
264
265 </code></pre>
266 </notextile>
267
268 Get the @SubscriptionID@ and @TenantID@:
269
270 <pre>
271 $ az account list
272 [
273   {
274     "cloudName": "AzureCloud",
275     "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX",
276     "isDefault": true,
277     "name": "Your Subscription",
278     "state": "Enabled",
279     "tenantId": "YYYYYYYY-YYYY-YYYY-YYYYYYYY",
280     "user": {
281       "name": "you@example.com",
282       "type": "user"
283     }
284   }
285 ]
286 </pre>
287
288 You will need to create a "service principal" to use as a delegated authority for API access.
289
290 <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>
291 $ az ad sp create "<span class="userinput">appId</span>"
292 (appId is part of the response of the previous command)
293 $ az role assignment create --assignee "<span class="userinput">objectId</span>" --role Owner --scope /subscriptions/{subscriptionId}/
294 (objectId is part of the response of the previous command)
295 </code></pre></notextile>
296
297 Now update your @config.yml@ file:
298
299 @ClientID@ is the 'appId' value.
300
301 @ClientSecret@ is what was provided as <span class="userinput">Your_Password</span>.
302
303 h3. Test your configuration
304
305 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.
306
307 <notextile>
308 <pre><code>~$ <span class="userinput">arvados-server cloudtest && echo "OK!"</span>
309 </code></pre>
310 </notextile>
311
312 Refer to the "cloudtest tool documentation":../../admin/cloudtest.html for more information.
313
314 {% assign arvados_component = 'arvados-dispatch-cloud' %}
315
316 {% include 'install_packages' %}
317
318 {% include 'start_service' %}
319
320 {% include 'restart_api' %}
321
322 h2(#confirm-working). Confirm working installation
323
324 On the dispatch node, start monitoring the arvados-dispatch-cloud logs:
325
326 <notextile>
327 <pre><code>~$ <span class="userinput">sudo journalctl -o cat -fu arvados-dispatch-cloud.service</span>
328 </code></pre>
329 </notextile>
330
331 "Make sure to install the arvados/jobs image.":../install-jobs-image.html
332
333 Submit a simple container request:
334
335 <notextile>
336 <pre><code>shell:~$ <span class="userinput">arv container_request create --container-request '{
337   "name":            "test",
338   "state":           "Committed",
339   "priority":        1,
340   "container_image": "arvados/jobs:latest",
341   "command":         ["echo", "Hello, Crunch!"],
342   "output_path":     "/out",
343   "mounts": {
344     "/out": {
345       "kind":        "tmp",
346       "capacity":    1000
347     }
348   },
349   "runtime_constraints": {
350     "vcpus": 1,
351     "ram": 1048576
352   }
353 }'</span>
354 </code></pre>
355 </notextile>
356
357 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.
358
359 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:
360
361 <notextile>
362 <pre><code>~$ <span class="userinput">curl -sH "Authorization: Bearer $token" http://localhost:9006/arvados/v1/dispatch/containers</span>
363 {
364   "items": [
365     {
366       "container": {
367         "uuid": "zzzzz-dz642-hdp2vpu9nq14tx0",
368         ...
369         "state": "Running",
370         "scheduling_parameters": {
371           "partitions": null,
372           "preemptible": false,
373           "max_run_time": 0
374         },
375         "exit_code": 0,
376         "runtime_status": null,
377         "started_at": null,
378         "finished_at": null
379       },
380       "instance_type": {
381         "Name": "Standard_D2s_v3",
382         "ProviderType": "Standard_D2s_v3",
383         "VCPUs": 2,
384         "RAM": 8589934592,
385         "Scratch": 16000000000,
386         "IncludedScratch": 16000000000,
387         "AddedScratch": 0,
388         "Price": 0.11,
389         "Preemptible": false
390       }
391     }
392   ]
393 }
394 </code></pre>
395 </notextile>
396
397 A similar request can be made to the @http://localhost:9006/arvados/v1/dispatch/instances@ endpoint.
398
399 When the container finishes, the dispatcher will log it.
400
401 After the container finishes, you can get the container record by UUID *from a shell server* to see its results:
402
403 <notextile>
404 <pre><code>shell:~$ <span class="userinput">arv get <b>zzzzz-dz642-hdp2vpu9nq14tx0</b></span>
405 {
406  ...
407  "exit_code":0,
408  "log":"a01df2f7e5bc1c2ad59c60a837e90dc6+166",
409  "output":"d41d8cd98f00b204e9800998ecf8427e+0",
410  "state":"Complete",
411  ...
412 }
413 </code></pre>
414 </notextile>
415
416 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:
417
418 <notextile>
419 <pre><code>~$ <span class="userinput">arv keep ls <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b></span>
420 ./crunch-run.txt
421 ./stderr.txt
422 ./stdout.txt
423 ~$ <span class="userinput">arv-get <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b>/stdout.txt</span>
424 2016-08-05T13:53:06.201011Z Hello, Crunch!
425 </code></pre>
426 </notextile>
427
428 If the container does not dispatch successfully, refer to the @arvados-dispatch-cloud@ logs for information about why it failed.