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