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