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.
  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 h2(#update-config). Update config.yml
  31
  32 h3. Configure CloudVMs
  33
  34 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.
  35
  36 <notextile>
  37 <pre><code>    Services:
  38       DispatchCloud:
  39         InternalURLs:
  40           "http://localhost:9006": {}
  41     Containers:
  42       CloudVMs:
  43         # BootProbeCommand is a shell command that succeeds when an instance is ready for service
  44         BootProbeCommand: "sudo systemctl status docker"
  45
  46         <b># --- driver-specific configuration goes here --- see Amazon and Azure examples below ---</b>
  47
  48       DispatchPrivateKey: |
  49         -----BEGIN RSA PRIVATE KEY-----
  50         MIIEpQIBAAKCAQEAqXoCzcOBkFQ7w4dvXf9B++1ctgZRqEbgRYL3SstuMV4oawks
  51         ttUuxJycDdsPmeYcHsKo8vsEZpN6iYsX6ZZzhkO5nEayUTU8sBjmg1ZCTo4QqKXr
  52         FJ+amZ7oYMDof6QEdwl6KNDfIddL+NfBCLQTVInOAaNss7GRrxLTuTV7HcRaIUUI
  53         jYg0Ibg8ZZTzQxCvFXXnjseTgmOcTv7CuuGdt91OVdoq8czG/w8TwOhymEb7mQlt
  54         lXuucwQvYgfoUgcnTgpJr7j+hafp75g2wlPozp8gJ6WQ2yBWcfqL2aw7m7Ll88Nd
  55         [...]
  56         oFyAjVoexx0RBcH6BveTfQtJKbktP1qBO4mXo2dP0cacuZEtlAqW9Eb06Pvaw/D9
  57         foktmqOY8MyctzFgXBpGTxPliGjqo8OkrOyQP2g+FL7v+Km31Xs61P8=
  58         -----END RSA PRIVATE KEY-----
  59     InstanceTypes:
  60       x1md:
  61         ProviderType: x1.medium
  62         VCPUs: 8
  63         RAM: 64GiB
  64         IncludedScratch: 64GB
  65         Price: 0.62
  66       x1lg:
  67         ProviderType: x1.large
  68         VCPUs: 16
  69         RAM: 128GiB
  70         IncludedScratch: 128GB
  71         Price: 1.23
  72 </code></pre>
  73 </notextile>
  74
  75 h4. Minimal configuration example for Amazon EC2
  76
  77 <notextile>
  78 <pre><code>    Containers:
  79       CloudVMs:
  80         ImageID: ami-01234567890abcdef
  81         Driver: ec2
  82         DriverParameters:
  83           AccessKeyID: XXXXXXXXXXXXXXXXXXXX
  84           SecretAccessKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
  85           SecurityGroupIDs:
  86           - sg-0123abcd
  87           SubnetID: subnet-0123abcd
  88           Region: us-east-1
  89           EBSVolumeType: gp2
  90           AdminUsername: arvados
  91 </code></pre>
  92 </notextile>
  93
  94 h4. Minimal configuration example for Azure
  95
  96 Using managed disks:
  97
  98 <notextile>
  99 <pre><code>    Containers:
 100       CloudVMs:
 101         ImageID: "zzzzz-compute-v1597349873"
 102         Driver: azure
 103         DriverParameters:
 104           # Credentials.
 105           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 106           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 107           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 108           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 109
 110           # Data center where VMs will be allocated
 111           Location: centralus
 112
 113           # The resource group where the VM and virtual NIC will be
 114           # created.
 115           ResourceGroup: zzzzz
 116           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 117           Network: xxxxx
 118           Subnet: xxxxx-subnet-private
 119
 120           # The resource group where the disk image is stored, only needs to
 121           # be specified if it is different from ResourceGroup
 122           ImageResourceGroup: aaaaa
 123
 124 </code></pre>
 125 </notextile>
 126
 127 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.
 128
 129 Using an image from a shared image gallery:
 130
 131 <notextile>
 132 <pre><code>    Containers:
 133       CloudVMs:
 134         ImageID: "shared_image_gallery_image_definition_name"
 135         Driver: azure
 136         DriverParameters:
 137           # Credentials.
 138           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 139           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 140           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 141           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 142
 143           # Data center where VMs will be allocated
 144           Location: centralus
 145
 146           # The resource group where the VM and virtual NIC will be
 147           # created.
 148           ResourceGroup: zzzzz
 149           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 150           Network: xxxxx
 151           Subnet: xxxxx-subnet-private
 152
 153           # The resource group where the disk image is stored, only needs to
 154           # be specified if it is different from ResourceGroup
 155           ImageResourceGroup: aaaaa
 156
 157           # (azure) shared image gallery: the name of the gallery
 158           SharedImageGalleryName: "shared_image_gallery_1"
 159           # (azure) shared image gallery: the version of the image definition
 160           SharedImageGalleryImageVersion: "0.0.1"
 161
 162 </code></pre>
 163 </notextile>
 164
 165 Using unmanaged disks (deprecated):
 166
 167 <notextile>
 168 <pre><code>    Containers:
 169       CloudVMs:
 170         ImageID: "https://zzzzzzzz.blob.core.windows.net/system/Microsoft.Compute/Images/images/zzzzz-compute-osDisk.55555555-5555-5555-5555-555555555555.vhd"
 171         Driver: azure
 172         DriverParameters:
 173           # Credentials.
 174           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 175           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 176           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 177           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 178
 179           # Data center where VMs will be allocated
 180           Location: centralus
 181
 182           # The resource group where the VM and virtual NIC will be
 183           # created.
 184           ResourceGroup: zzzzz
 185           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 186           Network: xxxxx
 187           Subnet: xxxxx-subnet-private
 188
 189           # Where to store the VM VHD blobs
 190           StorageAccount: example
 191           BlobContainer: vhds
 192
 193 </code></pre>
 194 </notextile>
 195
 196 Get the @SubscriptionID@ and @TenantID@:
 197
 198 <pre>
 199 $ az account list
 200 [
 201   {
 202     "cloudName": "AzureCloud",
 203     "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX",
 204     "isDefault": true,
 205     "name": "Your Subscription",
 206     "state": "Enabled",
 207     "tenantId": "YYYYYYYY-YYYY-YYYY-YYYYYYYY",
 208     "user": {
 209       "name": "you@example.com",
 210       "type": "user"
 211     }
 212   }
 213 ]
 214 </pre>
 215
 216 You will need to create a "service principal" to use as a delegated authority for API access.
 217
 218 <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>
 219 $ az ad sp create "<span class="userinput">appId</span>"
 220 (appId is part of the response of the previous command)
 221 $ az role assignment create --assignee "<span class="userinput">objectId</span>" --role Owner --scope /subscriptions/{subscriptionId}/
 222 (objectId is part of the response of the previous command)
 223 </code></pre></notextile>
 224
 225 Now update your @config.yml@ file:
 226
 227 @ClientID@ is the 'appId' value.
 228
 229 @ClientSecret@ is what was provided as <span class="userinput">Your_Password</span>.
 230
 231 h3. Test your configuration
 232
 233 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.
 234
 235 <notextile>
 236 <pre><code>~$ <span class="userinput">arvados-server cloudtest && echo "OK!"</span>
 237 </code></pre>
 238 </notextile>
 239
 240 Refer to the "cloudtest tool documentation":../../admin/cloudtest.html for more information.
 241
 242 {% assign arvados_component = 'arvados-dispatch-cloud' %}
 243
 244 {% include 'install_packages' %}
 245
 246 {% include 'start_service' %}
 247
 248 {% include 'restart_api' %}
 249
 250 h2(#confirm-working). Confirm working installation
 251
 252 On the dispatch node, start monitoring the arvados-dispatch-cloud logs:
 253
 254 <notextile>
 255 <pre><code>~$ <span class="userinput">sudo journalctl -o cat -fu arvados-dispatch-cloud.service</span>
 256 </code></pre>
 257 </notextile>
 258
 259 "Make sure to install the arvados/jobs image.":../install-jobs-image.html
 260
 261 Submit a simple container request:
 262
 263 <notextile>
 264 <pre><code>shell:~$ <span class="userinput">arv container_request create --container-request '{
 265   "name":            "test",
 266   "state":           "Committed",
 267   "priority":        1,
 268   "container_image": "arvados/jobs:latest",
 269   "command":         ["echo", "Hello, Crunch!"],
 270   "output_path":     "/out",
 271   "mounts": {
 272     "/out": {
 273       "kind":        "tmp",
 274       "capacity":    1000
 275     }
 276   },
 277   "runtime_constraints": {
 278     "vcpus": 1,
 279     "ram": 1048576
 280   }
 281 }'</span>
 282 </code></pre>
 283 </notextile>
 284
 285 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.
 286
 287 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:
 288
 289 <notextile>
 290 <pre><code>~$ <span class="userinput">curl -sH "Authorization: Bearer $token" http://localhost:9006/arvados/v1/dispatch/containers</span>
 291 {
 292   "items": [
 293     {
 294       "container": {
 295         "uuid": "zzzzz-dz642-hdp2vpu9nq14tx0",
 296         ...
 297         "state": "Running",
 298         "scheduling_parameters": {
 299           "partitions": null,
 300           "preemptible": false,
 301           "max_run_time": 0
 302         },
 303         "exit_code": 0,
 304         "runtime_status": null,
 305         "started_at": null,
 306         "finished_at": null
 307       },
 308       "instance_type": {
 309         "Name": "Standard_D2s_v3",
 310         "ProviderType": "Standard_D2s_v3",
 311         "VCPUs": 2,
 312         "RAM": 8589934592,
 313         "Scratch": 16000000000,
 314         "IncludedScratch": 16000000000,
 315         "AddedScratch": 0,
 316         "Price": 0.11,
 317         "Preemptible": false
 318       }
 319     }
 320   ]
 321 }
 322 </code></pre>
 323 </notextile>
 324
 325 A similar request can be made to the @http://localhost:9006/arvados/v1/dispatch/instances@ endpoint.
 326
 327 When the container finishes, the dispatcher will log it.
 328
 329 After the container finishes, you can get the container record by UUID *from a shell server* to see its results:
 330
 331 <notextile>
 332 <pre><code>shell:~$ <span class="userinput">arv get <b>zzzzz-dz642-hdp2vpu9nq14tx0</b></span>
 333 {
 334  ...
 335  "exit_code":0,
 336  "log":"a01df2f7e5bc1c2ad59c60a837e90dc6+166",
 337  "output":"d41d8cd98f00b204e9800998ecf8427e+0",
 338  "state":"Complete",
 339  ...
 340 }
 341 </code></pre>
 342 </notextile>
 343
 344 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:
 345
 346 <notextile>
 347 <pre><code>~$ <span class="userinput">arv keep ls <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b></span>
 348 ./crunch-run.txt
 349 ./stderr.txt
 350 ./stdout.txt
 351 ~$ <span class="userinput">arv-get <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b>/stdout.txt</span>
 352 2016-08-05T13:53:06.201011Z Hello, Crunch!
 353 </code></pre>
 354 </notextile>
 355
 356 If the container does not dispatch successfully, refer to the @arvados-dispatch-cloud@ logs for information about why it failed.