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 "Create a SSH keypair":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, "the compute image must be built with CUDA support":install-compute-node.html#nvidia , and 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":https://developer.nvidia.com/cuda-gpus.  The @DeviceCount@ is the number of GPU cores available for this instance type.
  97
  98 h3(#aws-ebs-autoscaler). EBS Autoscale configuration
  99
 100 See "Autoscaling compute node scratch space":install-compute-node.html#aws-ebs-autoscaler for details about compute image configuration.
 101
 102 The @Containers.InstanceTypes@ list should be modified so that all @AddedScratch@ lines are removed, and the @IncludedScratch@ value should be set to 5 TB. This way, the scratch space requirements will be met by all the defined instance type. For example:
 103
 104 <notextile><pre><code>    InstanceTypes:
 105       c5large:
 106         ProviderType: c5.large
 107         VCPUs: 2
 108         RAM: 4GiB
 109         IncludedScratch: 5TB
 110         Price: 0.085
 111       m5large:
 112         ProviderType: m5.large
 113         VCPUs: 2
 114         RAM: 8GiB
 115         IncludedScratch: 5TB
 116         Price: 0.096
 117 ...
 118 </code></pre></notextile>
 119
 120 You will also need to create an IAM role in AWS with these permissions:
 121
 122 <notextile><pre><code>{
 123     "Statement": [
 124         {
 125             "Effect": "Allow",
 126             "Action": [
 127                 "ec2:AttachVolume",
 128                 "ec2:DescribeVolumeStatus",
 129                 "ec2:DescribeVolumes",
 130                 "ec2:DescribeTags",
 131                 "ec2:ModifyInstanceAttribute",
 132                 "ec2:DescribeVolumeAttribute",
 133                 "ec2:CreateVolume",
 134                 "ec2:DeleteVolume",
 135                 "ec2:CreateTags"
 136             ],
 137             "Resource": "*"
 138         }
 139     ]
 140 }
 141 </code></pre></notextile>
 142
 143 Then set @Containers.CloudVMs.DriverParameters.IAMInstanceProfile@ to the name of the IAM role. This will make @arvados-dispatch-cloud@ pass an IAM instance profile to the compute nodes when they start up, giving them sufficient permissions to attach and grow EBS volumes.
 144
 145 h3. AWS Credentials for Local Keepstore on Compute node
 146
 147 When @Containers.LocalKeepBlobBuffersPerVCPU@ is non-zero, the compute node will spin up a local Keepstore service for direct storage access. If Keep is backed by S3, the compute node will need to be able to access the S3 bucket.
 148
 149 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.
 150
 151 If @config.yml@ does not have @Volumes.DriverParameters.AccessKeyID@ and @Volumes.DriverParameters.SecretAccessKey@ defined, Keepstore uses instance metadata to retrieve IAM role credentials. The @CloudVMs.DriverParameters.IAMInstanceProfile@ parameter must be configured with the name of a profile whose IAM role has permission to access the S3 bucket(s). With this setup, @arvados-dispatch-cloud@ will attach the IAM role to the compute node as it is created. The instance profile name is "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.
 152
 153 *If you are also using EBS Autoscale feature, the role in @IAMInstanceProfile@ must have both ec2 and s3 permissions.*
 154
 155 h3. Minimal configuration example for Amazon EC2
 156
 157 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#aws.
 158
 159 <notextile>
 160 <pre><code>    Containers:
 161       CloudVMs:
 162         ImageID: <span class="userinput">ami-01234567890abcdef</span>
 163         Driver: ec2
 164         DriverParameters:
 165           # If you are not using an IAM role for authentication, specify access
 166           # credentials here. Otherwise, omit or set AccessKeyID and
 167           # SecretAccessKey to an empty value.
 168           AccessKeyID: XXXXXXXXXXXXXXXXXXXX
 169           SecretAccessKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
 170
 171           SecurityGroupIDs:
 172           - sg-0123abcd
 173           SubnetID: subnet-0123abcd
 174           Region: us-east-1
 175           EBSVolumeType: gp2
 176           AdminUsername: arvados
 177 </code></pre>
 178 </notextile>
 179
 180 h3(#IAM). Example IAM policy for cloud dispatcher
 181
 182 Example policy for the IAM role used by the cloud dispatcher:
 183
 184 <notextile>
 185 <pre>
 186 {
 187     "Id": "arvados-dispatch-cloud policy",
 188     "Statement": [
 189         {
 190             "Effect": "Allow",
 191             "Action": [
 192                   "ec2:CreateTags",
 193                   "ec2:Describe*",
 194                   "ec2:CreateImage",
 195                   "ec2:CreateKeyPair",
 196                   "ec2:ImportKeyPair",
 197                   "ec2:DeleteKeyPair",
 198                   "ec2:RunInstances",
 199                   "ec2:StopInstances",
 200                   "ec2:TerminateInstances",
 201                   "ec2:ModifyInstanceAttribute",
 202                   "ec2:CreateSecurityGroup",
 203                   "ec2:DeleteSecurityGroup",
 204                   "iam:PassRole"
 205             ],
 206             "Resource": "*"
 207         }
 208     ]
 209 }
 210 </pre>
 211 </notextile>
 212
 213 h3. Minimal configuration example for Azure
 214
 215 Using managed disks:
 216
 217 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#azure.
 218
 219 <notextile>
 220 <pre><code>    Containers:
 221       CloudVMs:
 222         ImageID: <span class="userinput">"zzzzz-compute-v1597349873"</span>
 223         Driver: azure
 224         # (azure) managed disks: set MaxConcurrentInstanceCreateOps to 20 to avoid timeouts, cf
 225         # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
 226         MaxConcurrentInstanceCreateOps: 20
 227         DriverParameters:
 228           # Credentials.
 229           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 230           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 231           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 232           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 233
 234           # Data center where VMs will be allocated
 235           Location: centralus
 236
 237           # The resource group where the VM and virtual NIC will be
 238           # created.
 239           ResourceGroup: zzzzz
 240           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 241           Network: xxxxx
 242           Subnet: xxxxx-subnet-private
 243
 244           # The resource group where the disk image is stored, only needs to
 245           # be specified if it is different from ResourceGroup
 246           ImageResourceGroup: aaaaa
 247
 248 </code></pre>
 249 </notextile>
 250
 251 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.
 252
 253 Using an image from a shared image gallery:
 254
 255 <notextile>
 256 <pre><code>    Containers:
 257       CloudVMs:
 258         ImageID: <span class="userinput">"shared_image_gallery_image_definition_name"</span>
 259         Driver: azure
 260         DriverParameters:
 261           # Credentials.
 262           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 263           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 264           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 265           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 266
 267           # Data center where VMs will be allocated
 268           Location: centralus
 269
 270           # The resource group where the VM and virtual NIC will be
 271           # created.
 272           ResourceGroup: zzzzz
 273           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 274           Network: xxxxx
 275           Subnet: xxxxx-subnet-private
 276
 277           # The resource group where the disk image is stored, only needs to
 278           # be specified if it is different from ResourceGroup
 279           ImageResourceGroup: aaaaa
 280
 281           # (azure) shared image gallery: the name of the gallery
 282           SharedImageGalleryName: "shared_image_gallery_1"
 283           # (azure) shared image gallery: the version of the image definition
 284           SharedImageGalleryImageVersion: "0.0.1"
 285
 286 </code></pre>
 287 </notextile>
 288
 289 Using unmanaged disks (deprecated):
 290
 291 The <span class="userinput">ImageID</span> value is the compute node image that was built in "the previous section":install-compute-node.html#azure.
 292
 293 <notextile>
 294 <pre><code>    Containers:
 295       CloudVMs:
 296         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>
 297         Driver: azure
 298         DriverParameters:
 299           # Credentials.
 300           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 301           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 302           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 303           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 304
 305           # Data center where VMs will be allocated
 306           Location: centralus
 307
 308           # The resource group where the VM and virtual NIC will be
 309           # created.
 310           ResourceGroup: zzzzz
 311           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 312           Network: xxxxx
 313           Subnet: xxxxx-subnet-private
 314
 315           # Where to store the VM VHD blobs
 316           StorageAccount: example
 317           BlobContainer: vhds
 318
 319 </code></pre>
 320 </notextile>
 321
 322 Get the @SubscriptionID@ and @TenantID@:
 323
 324 <pre>
 325 $ az account list
 326 [
 327   {
 328     "cloudName": "AzureCloud",
 329     "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX",
 330     "isDefault": true,
 331     "name": "Your Subscription",
 332     "state": "Enabled",
 333     "tenantId": "YYYYYYYY-YYYY-YYYY-YYYYYYYY",
 334     "user": {
 335       "name": "you@example.com",
 336       "type": "user"
 337     }
 338   }
 339 ]
 340 </pre>
 341
 342 You will need to create a "service principal" to use as a delegated authority for API access.
 343
 344 <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>
 345 $ az ad sp create "<span class="userinput">appId</span>"
 346 (appId is part of the response of the previous command)
 347 $ az role assignment create --assignee "<span class="userinput">objectId</span>" --role Owner --scope /subscriptions/{subscriptionId}/
 348 (objectId is part of the response of the previous command)
 349 </code></pre></notextile>
 350
 351 Now update your @config.yml@ file:
 352
 353 @ClientID@ is the 'appId' value.
 354
 355 @ClientSecret@ is what was provided as <span class="userinput">Your_Password</span>.
 356
 357 h3. Test your configuration
 358
 359 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.
 360
 361 <notextile>
 362 <pre><code>~$ <span class="userinput">arvados-server cloudtest && echo "OK!"</span>
 363 </code></pre>
 364 </notextile>
 365
 366 Refer to the "cloudtest tool documentation":../../admin/cloudtest.html for more information.
 367
 368 {% assign arvados_component = 'arvados-dispatch-cloud' %}
 369
 370 {% include 'install_packages' %}
 371
 372 {% include 'start_service' %}
 373
 374 {% include 'restart_api' %}
 375
 376 h2(#confirm-working). Confirm working installation
 377
 378 On the dispatch node, start monitoring the arvados-dispatch-cloud logs:
 379
 380 <notextile>
 381 <pre><code># <span class="userinput">journalctl -o cat -fu arvados-dispatch-cloud.service</span>
 382 </code></pre>
 383 </notextile>
 384
 385 In another terminal window, use the diagnostics tool to run a simple container.
 386
 387 <notextile>
 388 <pre><code># <span class="userinput">arvados-client sudo diagnostics</span>
 389 INFO       5: running health check (same as `arvados-server check`)
 390 INFO      10: getting discovery document from https://zzzzz.arvadosapi.com/discovery/v1/apis/arvados/v1/rest
 391 ...
 392 INFO     160: running a container
 393 INFO      ... container request submitted, waiting up to 10m for container to run
 394 </code></pre>
 395 </notextile>
 396
 397 After performing a number of other quick tests, this will submit a new container request and wait for it to finish.
 398
 399 While the diagnostics tool is waiting, the @arvados-dispatch-cloud@ logs will show details about creating a cloud instance, waiting for it to be ready, and scheduling the new container on it.
 400
 401 You can also use the "arvados-dispatch-cloud API":{{site.baseurl}}/api/dispatch.html to get 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:
 402
 403 <notextile>
 404 <pre><code>~$ <span class="userinput">curl -sH "Authorization: Bearer $token" http://localhost:9006/arvados/v1/dispatch/containers</span>
 405 {
 406   "items": [
 407     {
 408       "container": {
 409         "uuid": "zzzzz-dz642-hdp2vpu9nq14tx0",
 410         ...
 411         "state": "Running",
 412         "scheduling_parameters": {
 413           "partitions": null,
 414           "preemptible": false,
 415           "max_run_time": 0
 416         },
 417         "exit_code": 0,
 418         "runtime_status": null,
 419         "started_at": null,
 420         "finished_at": null
 421       },
 422       "instance_type": {
 423         "Name": "Standard_D2s_v3",
 424         "ProviderType": "Standard_D2s_v3",
 425         "VCPUs": 2,
 426         "RAM": 8589934592,
 427         "Scratch": 16000000000,
 428         "IncludedScratch": 16000000000,
 429         "AddedScratch": 0,
 430         "Price": 0.11,
 431         "Preemptible": false
 432       }
 433     }
 434   ]
 435 }
 436 </code></pre>
 437 </notextile>
 438
 439 A similar request can be made to the @http://localhost:9006/arvados/v1/dispatch/instances@ endpoint.
 440
 441 After the container finishes, you can get the container record by UUID *from a shell server* to see its results:
 442
 443 <notextile>
 444 <pre><code>shell:~$ <span class="userinput">arv get <b>zzzzz-dz642-hdp2vpu9nq14tx0</b></span>
 445 {
 446  ...
 447  "exit_code":0,
 448  "log":"a01df2f7e5bc1c2ad59c60a837e90dc6+166",
 449  "output":"d41d8cd98f00b204e9800998ecf8427e+0",
 450  "state":"Complete",
 451  ...
 452 }
 453 </code></pre>
 454 </notextile>
 455
 456 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:
 457
 458 <notextile>
 459 <pre><code>~$ <span class="userinput">arv keep ls <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b></span>
 460 ./crunch-run.txt
 461 ./stderr.txt
 462 ./stdout.txt
 463 ~$ <span class="userinput">arv-get <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b>/stdout.txt</span>
 464 2016-08-05T13:53:06.201011Z Hello, Crunch!
 465 </code></pre>
 466 </notextile>
 467
 468 If the container does not dispatch successfully, refer to the @arvados-dispatch-cloud@ logs for information about why it failed.