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 h4. 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>    Services:
  83     InstanceTypes:
  84       g4dn:
  85         ProviderType: g4dn.xlarge
  86         VCPUs: 4
  87         RAM: 16GiB
  88         IncludedScratch: 125GB
  89         Price: 0.56
  90         CUDA:
  91           DriverVersion: "11.4"
  92           HardwareCapability: "7.5"
  93           DeviceCount: 1
  94 </code></pre>
  95 </notextile>
  96
  97 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.
  98
  99 h4. Minimal configuration example for Amazon EC2
 100
 101 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#aws.
 102
 103 <notextile>
 104 <pre><code>    Containers:
 105       CloudVMs:
 106         ImageID: <span class="userinput">ami-01234567890abcdef</span>
 107         Driver: ec2
 108         DriverParameters:
 109           # If you are not using an IAM role for authentication, specify access
 110           # credentials here. Otherwise, omit or set AccessKeyID and
 111           # SecretAccessKey to an empty value.
 112           AccessKeyID: XXXXXXXXXXXXXXXXXXXX
 113           SecretAccessKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
 114
 115           SecurityGroupIDs:
 116           - sg-0123abcd
 117           SubnetID: subnet-0123abcd
 118           Region: us-east-1
 119           EBSVolumeType: gp2
 120           AdminUsername: arvados
 121 </code></pre>
 122 </notextile>
 123
 124 h4. Minimal configuration example for Azure
 125
 126 Using managed disks:
 127
 128 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#azure.
 129
 130 <notextile>
 131 <pre><code>    Containers:
 132       CloudVMs:
 133         ImageID: <span class="userinput">"zzzzz-compute-v1597349873"</span>
 134         Driver: azure
 135         # (azure) managed disks: set MaxConcurrentInstanceCreateOps to 20 to avoid timeouts, cf
 136         # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
 137         MaxConcurrentInstanceCreateOps: 20
 138         DriverParameters:
 139           # Credentials.
 140           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 141           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 142           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 143           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 144
 145           # Data center where VMs will be allocated
 146           Location: centralus
 147
 148           # The resource group where the VM and virtual NIC will be
 149           # created.
 150           ResourceGroup: zzzzz
 151           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 152           Network: xxxxx
 153           Subnet: xxxxx-subnet-private
 154
 155           # The resource group where the disk image is stored, only needs to
 156           # be specified if it is different from ResourceGroup
 157           ImageResourceGroup: aaaaa
 158
 159 </code></pre>
 160 </notextile>
 161
 162 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.
 163
 164 Using an image from a shared image gallery:
 165
 166 <notextile>
 167 <pre><code>    Containers:
 168       CloudVMs:
 169         ImageID: <span class="userinput">"shared_image_gallery_image_definition_name"</span>
 170         Driver: azure
 171         DriverParameters:
 172           # Credentials.
 173           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 174           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 175           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 176           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 177
 178           # Data center where VMs will be allocated
 179           Location: centralus
 180
 181           # The resource group where the VM and virtual NIC will be
 182           # created.
 183           ResourceGroup: zzzzz
 184           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 185           Network: xxxxx
 186           Subnet: xxxxx-subnet-private
 187
 188           # The resource group where the disk image is stored, only needs to
 189           # be specified if it is different from ResourceGroup
 190           ImageResourceGroup: aaaaa
 191
 192           # (azure) shared image gallery: the name of the gallery
 193           SharedImageGalleryName: "shared_image_gallery_1"
 194           # (azure) shared image gallery: the version of the image definition
 195           SharedImageGalleryImageVersion: "0.0.1"
 196
 197 </code></pre>
 198 </notextile>
 199
 200 Using unmanaged disks (deprecated):
 201
 202 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#azure.
 203
 204 <notextile>
 205 <pre><code>    Containers:
 206       CloudVMs:
 207         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>
 208         Driver: azure
 209         DriverParameters:
 210           # Credentials.
 211           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 212           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 213           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 214           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 215
 216           # Data center where VMs will be allocated
 217           Location: centralus
 218
 219           # The resource group where the VM and virtual NIC will be
 220           # created.
 221           ResourceGroup: zzzzz
 222           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 223           Network: xxxxx
 224           Subnet: xxxxx-subnet-private
 225
 226           # Where to store the VM VHD blobs
 227           StorageAccount: example
 228           BlobContainer: vhds
 229
 230 </code></pre>
 231 </notextile>
 232
 233 Get the @SubscriptionID@ and @TenantID@:
 234
 235 <pre>
 236 $ az account list
 237 [
 238   {
 239     "cloudName": "AzureCloud",
 240     "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX",
 241     "isDefault": true,
 242     "name": "Your Subscription",
 243     "state": "Enabled",
 244     "tenantId": "YYYYYYYY-YYYY-YYYY-YYYYYYYY",
 245     "user": {
 246       "name": "you@example.com",
 247       "type": "user"
 248     }
 249   }
 250 ]
 251 </pre>
 252
 253 You will need to create a "service principal" to use as a delegated authority for API access.
 254
 255 <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>
 256 $ az ad sp create "<span class="userinput">appId</span>"
 257 (appId is part of the response of the previous command)
 258 $ az role assignment create --assignee "<span class="userinput">objectId</span>" --role Owner --scope /subscriptions/{subscriptionId}/
 259 (objectId is part of the response of the previous command)
 260 </code></pre></notextile>
 261
 262 Now update your @config.yml@ file:
 263
 264 @ClientID@ is the 'appId' value.
 265
 266 @ClientSecret@ is what was provided as <span class="userinput">Your_Password</span>.
 267
 268 h3. Test your configuration
 269
 270 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.
 271
 272 <notextile>
 273 <pre><code>~$ <span class="userinput">arvados-server cloudtest && echo "OK!"</span>
 274 </code></pre>
 275 </notextile>
 276
 277 Refer to the "cloudtest tool documentation":../../admin/cloudtest.html for more information.
 278
 279 {% assign arvados_component = 'arvados-dispatch-cloud' %}
 280
 281 {% include 'install_packages' %}
 282
 283 {% include 'start_service' %}
 284
 285 {% include 'restart_api' %}
 286
 287 h2(#confirm-working). Confirm working installation
 288
 289 On the dispatch node, start monitoring the arvados-dispatch-cloud logs:
 290
 291 <notextile>
 292 <pre><code>~$ <span class="userinput">sudo journalctl -o cat -fu arvados-dispatch-cloud.service</span>
 293 </code></pre>
 294 </notextile>
 295
 296 "Make sure to install the arvados/jobs image.":../install-jobs-image.html
 297
 298 Submit a simple container request:
 299
 300 <notextile>
 301 <pre><code>shell:~$ <span class="userinput">arv container_request create --container-request '{
 302   "name":            "test",
 303   "state":           "Committed",
 304   "priority":        1,
 305   "container_image": "arvados/jobs:latest",
 306   "command":         ["echo", "Hello, Crunch!"],
 307   "output_path":     "/out",
 308   "mounts": {
 309     "/out": {
 310       "kind":        "tmp",
 311       "capacity":    1000
 312     }
 313   },
 314   "runtime_constraints": {
 315     "vcpus": 1,
 316     "ram": 1048576
 317   }
 318 }'</span>
 319 </code></pre>
 320 </notextile>
 321
 322 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.
 323
 324 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:
 325
 326 <notextile>
 327 <pre><code>~$ <span class="userinput">curl -sH "Authorization: Bearer $token" http://localhost:9006/arvados/v1/dispatch/containers</span>
 328 {
 329   "items": [
 330     {
 331       "container": {
 332         "uuid": "zzzzz-dz642-hdp2vpu9nq14tx0",
 333         ...
 334         "state": "Running",
 335         "scheduling_parameters": {
 336           "partitions": null,
 337           "preemptible": false,
 338           "max_run_time": 0
 339         },
 340         "exit_code": 0,
 341         "runtime_status": null,
 342         "started_at": null,
 343         "finished_at": null
 344       },
 345       "instance_type": {
 346         "Name": "Standard_D2s_v3",
 347         "ProviderType": "Standard_D2s_v3",
 348         "VCPUs": 2,
 349         "RAM": 8589934592,
 350         "Scratch": 16000000000,
 351         "IncludedScratch": 16000000000,
 352         "AddedScratch": 0,
 353         "Price": 0.11,
 354         "Preemptible": false
 355       }
 356     }
 357   ]
 358 }
 359 </code></pre>
 360 </notextile>
 361
 362 A similar request can be made to the @http://localhost:9006/arvados/v1/dispatch/instances@ endpoint.
 363
 364 When the container finishes, the dispatcher will log it.
 365
 366 After the container finishes, you can get the container record by UUID *from a shell server* to see its results:
 367
 368 <notextile>
 369 <pre><code>shell:~$ <span class="userinput">arv get <b>zzzzz-dz642-hdp2vpu9nq14tx0</b></span>
 370 {
 371  ...
 372  "exit_code":0,
 373  "log":"a01df2f7e5bc1c2ad59c60a837e90dc6+166",
 374  "output":"d41d8cd98f00b204e9800998ecf8427e+0",
 375  "state":"Complete",
 376  ...
 377 }
 378 </code></pre>
 379 </notextile>
 380
 381 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:
 382
 383 <notextile>
 384 <pre><code>~$ <span class="userinput">arv keep ls <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b></span>
 385 ./crunch-run.txt
 386 ./stderr.txt
 387 ./stdout.txt
 388 ~$ <span class="userinput">arv-get <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b>/stdout.txt</span>
 389 2016-08-05T13:53:06.201011Z Hello, Crunch!
 390 </code></pre>
 391 </notextile>
 392
 393 If the container does not dispatch successfully, refer to the @arvados-dispatch-cloud@ logs for information about why it failed.