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 h3(#IAM). Example IAM policy
 134
 135 Example policy for the IAM role used by the cloud dispatcher:
 136
 137 <notextile>
 138 <pre>
 139 {
 140     "Version": "2012-10-17",
 141     "Id": "arvados-dispatch-cloud policy",
 142     "Statement": [
 143         {
 144             "Effect": "Allow",
 145             "Action": [
 146                   "ec2:CreateTags",
 147                   "ec2:Describe*",
 148                   "ec2:CreateImage",
 149                   "ec2:CreateKeyPair",
 150                   "ec2:ImportKeyPair",
 151                   "ec2:DeleteKeyPair",
 152                   "ec2:RunInstances",
 153                   "ec2:StopInstances",
 154                   "ec2:TerminateInstances",
 155                   "ec2:ModifyInstanceAttribute",
 156                   "ec2:CreateSecurityGroup",
 157                   "ec2:DeleteSecurityGroup",
 158                   "iam:PassRole"
 159             ],
 160             "Resource": "*"
 161         }
 162     ]
 163 }
 164 </pre>
 165 </notextile>
 166
 167 h3. Minimal configuration example for Azure
 168
 169 Using managed disks:
 170
 171 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#azure.
 172
 173 <notextile>
 174 <pre><code>    Containers:
 175       CloudVMs:
 176         ImageID: <span class="userinput">"zzzzz-compute-v1597349873"</span>
 177         Driver: azure
 178         # (azure) managed disks: set MaxConcurrentInstanceCreateOps to 20 to avoid timeouts, cf
 179         # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
 180         MaxConcurrentInstanceCreateOps: 20
 181         DriverParameters:
 182           # Credentials.
 183           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 184           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 185           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 186           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 187
 188           # Data center where VMs will be allocated
 189           Location: centralus
 190
 191           # The resource group where the VM and virtual NIC will be
 192           # created.
 193           ResourceGroup: zzzzz
 194           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 195           Network: xxxxx
 196           Subnet: xxxxx-subnet-private
 197
 198           # The resource group where the disk image is stored, only needs to
 199           # be specified if it is different from ResourceGroup
 200           ImageResourceGroup: aaaaa
 201
 202 </code></pre>
 203 </notextile>
 204
 205 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.
 206
 207 Using an image from a shared image gallery:
 208
 209 <notextile>
 210 <pre><code>    Containers:
 211       CloudVMs:
 212         ImageID: <span class="userinput">"shared_image_gallery_image_definition_name"</span>
 213         Driver: azure
 214         DriverParameters:
 215           # Credentials.
 216           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 217           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 218           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 219           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 220
 221           # Data center where VMs will be allocated
 222           Location: centralus
 223
 224           # The resource group where the VM and virtual NIC will be
 225           # created.
 226           ResourceGroup: zzzzz
 227           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 228           Network: xxxxx
 229           Subnet: xxxxx-subnet-private
 230
 231           # The resource group where the disk image is stored, only needs to
 232           # be specified if it is different from ResourceGroup
 233           ImageResourceGroup: aaaaa
 234
 235           # (azure) shared image gallery: the name of the gallery
 236           SharedImageGalleryName: "shared_image_gallery_1"
 237           # (azure) shared image gallery: the version of the image definition
 238           SharedImageGalleryImageVersion: "0.0.1"
 239
 240 </code></pre>
 241 </notextile>
 242
 243 Using unmanaged disks (deprecated):
 244
 245 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#azure.
 246
 247 <notextile>
 248 <pre><code>    Containers:
 249       CloudVMs:
 250         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>
 251         Driver: azure
 252         DriverParameters:
 253           # Credentials.
 254           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 255           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 256           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 257           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 258
 259           # Data center where VMs will be allocated
 260           Location: centralus
 261
 262           # The resource group where the VM and virtual NIC will be
 263           # created.
 264           ResourceGroup: zzzzz
 265           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 266           Network: xxxxx
 267           Subnet: xxxxx-subnet-private
 268
 269           # Where to store the VM VHD blobs
 270           StorageAccount: example
 271           BlobContainer: vhds
 272
 273 </code></pre>
 274 </notextile>
 275
 276 Get the @SubscriptionID@ and @TenantID@:
 277
 278 <pre>
 279 $ az account list
 280 [
 281   {
 282     "cloudName": "AzureCloud",
 283     "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX",
 284     "isDefault": true,
 285     "name": "Your Subscription",
 286     "state": "Enabled",
 287     "tenantId": "YYYYYYYY-YYYY-YYYY-YYYYYYYY",
 288     "user": {
 289       "name": "you@example.com",
 290       "type": "user"
 291     }
 292   }
 293 ]
 294 </pre>
 295
 296 You will need to create a "service principal" to use as a delegated authority for API access.
 297
 298 <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>
 299 $ az ad sp create "<span class="userinput">appId</span>"
 300 (appId is part of the response of the previous command)
 301 $ az role assignment create --assignee "<span class="userinput">objectId</span>" --role Owner --scope /subscriptions/{subscriptionId}/
 302 (objectId is part of the response of the previous command)
 303 </code></pre></notextile>
 304
 305 Now update your @config.yml@ file:
 306
 307 @ClientID@ is the 'appId' value.
 308
 309 @ClientSecret@ is what was provided as <span class="userinput">Your_Password</span>.
 310
 311 h3. Test your configuration
 312
 313 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.
 314
 315 <notextile>
 316 <pre><code>~$ <span class="userinput">arvados-server cloudtest && echo "OK!"</span>
 317 </code></pre>
 318 </notextile>
 319
 320 Refer to the "cloudtest tool documentation":../../admin/cloudtest.html for more information.
 321
 322 {% assign arvados_component = 'arvados-dispatch-cloud' %}
 323
 324 {% include 'install_packages' %}
 325
 326 {% include 'start_service' %}
 327
 328 {% include 'restart_api' %}
 329
 330 h2(#confirm-working). Confirm working installation
 331
 332 On the dispatch node, start monitoring the arvados-dispatch-cloud logs:
 333
 334 <notextile>
 335 <pre><code>~$ <span class="userinput">sudo journalctl -o cat -fu arvados-dispatch-cloud.service</span>
 336 </code></pre>
 337 </notextile>
 338
 339 "Make sure to install the arvados/jobs image.":../install-jobs-image.html
 340
 341 Submit a simple container request:
 342
 343 <notextile>
 344 <pre><code>shell:~$ <span class="userinput">arv container_request create --container-request '{
 345   "name":            "test",
 346   "state":           "Committed",
 347   "priority":        1,
 348   "container_image": "arvados/jobs:latest",
 349   "command":         ["echo", "Hello, Crunch!"],
 350   "output_path":     "/out",
 351   "mounts": {
 352     "/out": {
 353       "kind":        "tmp",
 354       "capacity":    1000
 355     }
 356   },
 357   "runtime_constraints": {
 358     "vcpus": 1,
 359     "ram": 1048576
 360   }
 361 }'</span>
 362 </code></pre>
 363 </notextile>
 364
 365 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.
 366
 367 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:
 368
 369 <notextile>
 370 <pre><code>~$ <span class="userinput">curl -sH "Authorization: Bearer $token" http://localhost:9006/arvados/v1/dispatch/containers</span>
 371 {
 372   "items": [
 373     {
 374       "container": {
 375         "uuid": "zzzzz-dz642-hdp2vpu9nq14tx0",
 376         ...
 377         "state": "Running",
 378         "scheduling_parameters": {
 379           "partitions": null,
 380           "preemptible": false,
 381           "max_run_time": 0
 382         },
 383         "exit_code": 0,
 384         "runtime_status": null,
 385         "started_at": null,
 386         "finished_at": null
 387       },
 388       "instance_type": {
 389         "Name": "Standard_D2s_v3",
 390         "ProviderType": "Standard_D2s_v3",
 391         "VCPUs": 2,
 392         "RAM": 8589934592,
 393         "Scratch": 16000000000,
 394         "IncludedScratch": 16000000000,
 395         "AddedScratch": 0,
 396         "Price": 0.11,
 397         "Preemptible": false
 398       }
 399     }
 400   ]
 401 }
 402 </code></pre>
 403 </notextile>
 404
 405 A similar request can be made to the @http://localhost:9006/arvados/v1/dispatch/instances@ endpoint.
 406
 407 When the container finishes, the dispatcher will log it.
 408
 409 After the container finishes, you can get the container record by UUID *from a shell server* to see its results:
 410
 411 <notextile>
 412 <pre><code>shell:~$ <span class="userinput">arv get <b>zzzzz-dz642-hdp2vpu9nq14tx0</b></span>
 413 {
 414  ...
 415  "exit_code":0,
 416  "log":"a01df2f7e5bc1c2ad59c60a837e90dc6+166",
 417  "output":"d41d8cd98f00b204e9800998ecf8427e+0",
 418  "state":"Complete",
 419  ...
 420 }
 421 </code></pre>
 422 </notextile>
 423
 424 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:
 425
 426 <notextile>
 427 <pre><code>~$ <span class="userinput">arv keep ls <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b></span>
 428 ./crunch-run.txt
 429 ./stderr.txt
 430 ./stdout.txt
 431 ~$ <span class="userinput">arv-get <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b>/stdout.txt</span>
 432 2016-08-05T13:53:06.201011Z Hello, Crunch!
 433 </code></pre>
 434 </notextile>
 435
 436 If the container does not dispatch successfully, refer to the @arvados-dispatch-cloud@ logs for information about why it failed.