doc/install/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 a on premise 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(#create-image). Create compute node VM image and configure resolver
  31
  32 Set up a VM following the steps "to set up a compute node":crunch2-slurm/install-compute-node.html
  33
  34 Compute nodes must be able to resolve the hostnames of the API server and any keepstore servers to your internal IP addresses.  You can do this by running an internal DNS resolver and configuring the compute VMs to use that resolver, or by hardcoding the services in the @/etc/hosts@ file.  For example:
  35
  36 <notextile><pre><code>10.20.30.40     <span class="userinput">ClusterID.example.com</span>
  37 10.20.30.41     <span class="userinput">keep1.ClusterID.example.com</span>
  38 10.20.30.42     <span class="userinput">keep2.ClusterID.example.com</span>
  39 </code></pre></notextile>
  40
  41 Once the VM is fully configured, create a reusable VM image from it and make note of the image id.
  42
  43 h2(#update-config). Update config.yml
  44
  45 h3. Create a private key
  46
  47 Generate an SSH private key with no passphrase. Save it in the cluster configuration file (see @PrivateKey@ in the example below).
  48
  49 <notextile>
  50 <pre><code>~$ <span class="userinput">ssh-keygen -N '' -f ~/.ssh/id_dispatcher</span>
  51 Generating public/private rsa key pair.
  52 Your identification has been saved in /home/user/.ssh/id_dispatcher.
  53 Your public key has been saved in /home/user/.ssh/id_dispatcher.pub.
  54 The key fingerprint is:
  55 [...]
  56 ~$ <span class="userinput">cat ~/.ssh/id_dispatcher</span>
  57 -----BEGIN RSA PRIVATE KEY-----
  58 MIIEpQIBAAKCAQEAqXoCzcOBkFQ7w4dvXf9B++1ctgZRqEbgRYL3SstuMV4oawks
  59 ttUuxJycDdsPmeYcHsKo8vsEZpN6iYsX6ZZzhkO5nEayUTU8sBjmg1ZCTo4QqKXr
  60 ...
  61 oFyAjVoexx0RBcH6BveTfQtJKbktP1qBO4mXo2dP0cacuZEtlAqW9Eb06Pvaw/D9
  62 foktmqOY8MyctzFgXBpGTxPliGjqo8OkrOyQP2g+FL7v+Km31Xs61P8=
  63 -----END RSA PRIVATE KEY-----
  64 </code></pre>
  65 </notextile>
  66
  67 You can delete the key files after you have copied the private key to your configuration file.
  68
  69 <notextile>
  70 <pre><code>~$ <span class="userinput">rm ~/.ssh/id_dispatcher ~/.ssh/id_dispatcher.pub</span>
  71 </code></pre>
  72 </notextile>
  73
  74 h3. Configure CloudVMs
  75
  76 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.
  77
  78 <notextile>
  79 <pre><code>    Services:
  80       DispatchCloud:
  81         InternalURLs:
  82           "http://localhost:9006": {}
  83     Containers:
  84       CloudVMs:
  85         # BootProbeCommand is a shell command that succeeds when an instance is ready for service
  86         BootProbeCommand: "sudo systemctl status docker"
  87
  88         <b># --- driver-specific configuration goes here --- see Amazon and Azure examples below ---</b>
  89
  90       DispatchPrivateKey: |
  91         -----BEGIN RSA PRIVATE KEY-----
  92         MIIEpQIBAAKCAQEAqXoCzcOBkFQ7w4dvXf9B++1ctgZRqEbgRYL3SstuMV4oawks
  93         ttUuxJycDdsPmeYcHsKo8vsEZpN6iYsX6ZZzhkO5nEayUTU8sBjmg1ZCTo4QqKXr
  94         FJ+amZ7oYMDof6QEdwl6KNDfIddL+NfBCLQTVInOAaNss7GRrxLTuTV7HcRaIUUI
  95         jYg0Ibg8ZZTzQxCvFXXnjseTgmOcTv7CuuGdt91OVdoq8czG/w8TwOhymEb7mQlt
  96         lXuucwQvYgfoUgcnTgpJr7j+hafp75g2wlPozp8gJ6WQ2yBWcfqL2aw7m7Ll88Nd
  97         [...]
  98         oFyAjVoexx0RBcH6BveTfQtJKbktP1qBO4mXo2dP0cacuZEtlAqW9Eb06Pvaw/D9
  99         foktmqOY8MyctzFgXBpGTxPliGjqo8OkrOyQP2g+FL7v+Km31Xs61P8=
 100         -----END RSA PRIVATE KEY-----
 101     InstanceTypes:
 102       x1md:
 103         ProviderType: x1.medium
 104         VCPUs: 8
 105         RAM: 64GiB
 106         IncludedScratch: 64GB
 107         Price: 0.62
 108       x1lg:
 109         ProviderType: x1.large
 110         VCPUs: 16
 111         RAM: 128GiB
 112         IncludedScratch: 128GB
 113         Price: 1.23
 114 </code></pre>
 115 </notextile>
 116
 117 h4. Minimal configuration example for Amazon EC2
 118
 119 <notextile>
 120 <pre><code>    Containers:
 121       CloudVMs:
 122         ImageID: ami-01234567890abcdef
 123         Driver: ec2
 124         DriverParameters:
 125           AccessKeyID: XXXXXXXXXXXXXXXXXXXX
 126           SecretAccessKey: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
 127           SecurityGroupIDs:
 128           - sg-0123abcd
 129           SubnetID: subnet-0123abcd
 130           Region: us-east-1
 131           EBSVolumeType: gp2
 132           AdminUsername: arvados
 133 </code></pre>
 134 </notextile>
 135
 136 h4. Minimal configuration example for Azure
 137
 138 <notextile>
 139 <pre><code>    Containers:
 140       CloudVMs:
 141         ImageID: "https://zzzzzzzz.blob.core.windows.net/system/Microsoft.Compute/Images/images/zzzzz-compute-osDisk.55555555-5555-5555-5555-555555555555.vhd"
 142         Driver: azure
 143         DriverParameters:
 144           # Credentials.
 145           SubscriptionID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 146           ClientID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 147           ClientSecret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 148           TenantID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 149
 150           # Data center where VMs will be allocated
 151           Location: centralus
 152
 153           # The resource group where the VM and virtual NIC will be
 154           # created.
 155           ResourceGroup: zzzzz
 156           NetworkResourceGroup: yyyyy   # only if different from ResourceGroup
 157           Network: xxxxx
 158           Subnet: xxxxx-subnet-private
 159
 160           # Where to store the VM VHD blobs
 161           StorageAccount: example
 162           BlobContainer: vhds
 163
 164 </code></pre>
 165 </notextile>
 166
 167 Get the @SubscriptionID@ and @TenantID@:
 168
 169 <pre>
 170 $ az account list
 171 [
 172   {
 173     "cloudName": "AzureCloud",
 174     "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX",
 175     "isDefault": true,
 176     "name": "Your Subscription",
 177     "state": "Enabled",
 178     "tenantId": "YYYYYYYY-YYYY-YYYY-YYYYYYYY",
 179     "user": {
 180       "name": "you@example.com",
 181       "type": "user"
 182     }
 183   }
 184 ]
 185 </pre>
 186
 187 You will need to create a "service principal" to use as a delegated authority for API access.
 188
 189 <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>
 190 $ az ad sp create "<span class="userinput">appId</span>"
 191 (appId is part of the response of the previous command)
 192 $ az role assignment create --assignee "<span class="userinput">objectId</span>" --role Owner --scope /subscriptions/{subscriptionId}/
 193 (objectId is part of the response of the previous command)
 194 </code></pre></notextile>
 195
 196 Now update your @config.yml@ file:
 197
 198 @ClientID@ is the 'appId' value.
 199
 200 @ClientSecret@ is what was provided as <span class="userinput">Your_Password</span>.
 201
 202 h3. Test your configuration
 203
 204 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.
 205
 206 <notextile>
 207 <pre><code>~$ <span class="userinput">arvados-server cloudtest && echo "OK!"</span>
 208 </code></pre>
 209 </notextile>
 210
 211 Refer to the "cloudtest tool documentation":../admin/cloudtest.html for more information.
 212
 213 {% assign arvados_component = 'arvados-dispatch-cloud' %}
 214
 215 {% include 'install_packages' %}
 216
 217 {% include 'start_service' %}
 218
 219 {% include 'restart_api' %}
 220
 221 h2(#confirm-working). Confirm working installation
 222
 223 On the dispatch node, start monitoring the arvados-dispatch-cloud logs:
 224
 225 <notextile>
 226 <pre><code>~$ <span class="userinput">sudo journalctl -o cat -fu arvados-dispatch-cloud.service</span>
 227 </code></pre>
 228 </notextile>
 229
 230 "Make sure to install the arvados/jobs image.":install-jobs-image.html
 231
 232 Submit a simple container request:
 233
 234 <notextile>
 235 <pre><code>shell:~$ <span class="userinput">arv container_request create --container-request '{
 236   "name":            "test",
 237   "state":           "Committed",
 238   "priority":        1,
 239   "container_image": "arvados/jobs:latest",
 240   "command":         ["echo", "Hello, Crunch!"],
 241   "output_path":     "/out",
 242   "mounts": {
 243     "/out": {
 244       "kind":        "tmp",
 245       "capacity":    1000
 246     }
 247   },
 248   "runtime_constraints": {
 249     "vcpus": 1,
 250     "ram": 1048576
 251   }
 252 }'</span>
 253 </code></pre>
 254 </notextile>
 255
 256 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.
 257
 258 The @arvados-dispatch-cloud@ API a list of queued and running jobs.  For example:
 259
 260 <notextile>
 261 <pre><code>~$ <span class="userinput">curl ...</span>
 262 </code></pre>
 263 </notextile>
 264
 265 When the container finishes, the dispatcher will log it.
 266
 267 After the container finishes, you can get the container record by UUID *from a shell server* to see its results:
 268
 269 <notextile>
 270 <pre><code>shell:~$ <span class="userinput">arv get <b>zzzzz-dz642-hdp2vpu9nq14tx0</b></span>
 271 {
 272  ...
 273  "exit_code":0,
 274  "log":"a01df2f7e5bc1c2ad59c60a837e90dc6+166",
 275  "output":"d41d8cd98f00b204e9800998ecf8427e+0",
 276  "state":"Complete",
 277  ...
 278 }
 279 </code></pre>
 280 </notextile>
 281
 282 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:
 283
 284 <notextile>
 285 <pre><code>~$ <span class="userinput">arv keep ls <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b></span>
 286 ./crunch-run.txt
 287 ./stderr.txt
 288 ./stdout.txt
 289 ~$ <span class="userinput">arv-get <b>a01df2f7e5bc1c2ad59c60a837e90dc6+166</b>/stdout.txt</span>
 290 2016-08-05T13:53:06.201011Z Hello, Crunch!
 291 </code></pre>
 292 </notextile>
 293
 294 If the container does not dispatch successfully, refer to the @arvados-dispatch-cloud@ logs for information about why it failed.