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