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