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