doc/install/crunch2-cloud/install-compute-node.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Build a cloud compute node image
   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 or LSF.
  14 {% include 'notebox_end' %}
  15
  16 # "Introduction":#introduction
  17 # "Create an SSH keypair":#sshkeypair
  18 # "The build script":#building
  19 # "Singularity mksquashfs configuration":#singularity_mksquashfs_configuration
  20 # "Build an AWS image":#aws
  21 # "Build an Azure image":#azure
  22
  23 h2(#introduction). Introduction
  24
  25 This page describes how to build a compute node image that can be used to run containers dispatched by Arvados in the cloud.
  26
  27 Packer templates for AWS and Azure are provided with Arvados. To use them, the following are needed:
  28
  29 * "Packer":https://www.packer.io/
  30 * credentials for your cloud account
  31 * configuration details for your cloud account
  32
  33
  34 h2(#sshkeypair). Create a SSH keypair
  35
  36 @arvados-dispatch-cloud@ communicates with the compute nodes via SSH. To do this securely, a SSH keypair is needed.
  37
  38 Generate a SSH keypair with no passphrase. The private key needs to be stored in the cluster configuration file (see @Containers/DispatchPrivateKey@) for use by @arvados-dispatch-cloud@, as described in the "next section":install-dispatch-cloud.html#update-config. The public key will be baked into the compute node images, see the cloud-specific documentation below.
  39
  40 <notextile>
  41 <pre><code>~$ <span class="userinput">ssh-keygen -N '' -f ~/.ssh/id_dispatcher</span>
  42 Generating public/private rsa key pair.
  43 Your identification has been saved in /home/user/.ssh/id_dispatcher.
  44 Your public key has been saved in /home/user/.ssh/id_dispatcher.pub.
  45 The key fingerprint is:
  46 [...]
  47 ~$ <span class="userinput">cat ~/.ssh/id_dispatcher</span>
  48 -----BEGIN RSA PRIVATE KEY-----
  49 MIIEpQIBAAKCAQEAqXoCzcOBkFQ7w4dvXf9B++1ctgZRqEbgRYL3SstuMV4oawks
  50 ttUuxJycDdsPmeYcHsKo8vsEZpN6iYsX6ZZzhkO5nEayUTU8sBjmg1ZCTo4QqKXr
  51 ...
  52 oFyAjVoexx0RBcH6BveTfQtJKbktP1qBO4mXo2dP0cacuZEtlAqW9Eb06Pvaw/D9
  53 foktmqOY8MyctzFgXBpGTxPliGjqo8OkrOyQP2g+FL7v+Km31Xs61P8=
  54 -----END RSA PRIVATE KEY-----
  55 </code></pre>
  56 </notextile>
  57
  58 {% assign show_docker_warning = true %}
  59
  60 {% include 'singularity_mksquashfs_configuration' %}
  61
  62 The desired amount of memory to make available for @mksquashfs@ can be configured in an argument to the build script, see the next section. It defaults to @512M@.
  63
  64 h2(#building). The build script
  65
  66 The necessary files are located in the @arvados/tools/compute-images@ directory in the source tree. A build script is provided to generate the image. The @--help@ argument lists all available options:
  67
  68 <notextile><pre><code>~$ <span class="userinput">./build.sh --help</span>
  69 build.sh: Build cloud images for arvados-dispatch-cloud
  70
  71 Syntax:
  72         build.sh [options]
  73
  74 Options:
  75
  76   --json-file (required)
  77       Path to the packer json file
  78   --arvados-cluster-id (required)
  79       The ID of the Arvados cluster, e.g. zzzzz
  80   --aws-profile (default: false)
  81       AWS profile to use (valid profile from ~/.aws/config
  82   --aws-secrets-file (default: false, required if building for AWS)
  83       AWS secrets file which will be sourced from this script
  84   --aws-source-ami (default: false, required if building for AWS)
  85       The AMI to use as base for building the images
  86   --aws-region (default: us-east-1)
  87       The AWS region to use for building the images
  88   --aws-vpc-id (optional)
  89       VPC id for AWS, otherwise packer will pick the default one
  90   --aws-subnet-id
  91       Subnet id for AWS otherwise packer will pick the default one for the VPC
  92   --gcp-project-id (default: false, required if building for GCP)
  93       GCP project id
  94   --gcp-account-file (default: false, required if building for GCP)
  95       GCP account file
  96   --gcp-zone (default: us-central1-f)
  97       GCP zone
  98   --azure-secrets-file (default: false, required if building for Azure)
  99       Azure secrets file which will be sourced from this script
 100   --azure-resource-group (default: false, required if building for Azure)
 101       Azure resource group
 102   --azure-location (default: false, required if building for Azure)
 103       Azure location, e.g. centralus, eastus, westeurope
 104   --azure-sku (default: unset, required if building for Azure, e.g. 16.04-LTS)
 105       Azure SKU image to use
 106   --ssh_user  (default: packer)
 107       The user packer will use to log into the image
 108   --resolver (default: host's network provided)
 109       The dns resolver for the machine
 110   --reposuffix (default: unset)
 111       Set this to "-dev" to track the unstable/dev Arvados repositories
 112   --public-key-file (required)
 113       Path to the public key file that a-d-c will use to log into the compute node
 114   --mksquashfs-mem (default: 512M)
 115       Only relevant when using Singularity. This is the amount of memory mksquashfs is allowed to use.
 116   --debug
 117       Output debug information (default: false)
 118 </code></pre></notextile>
 119
 120 h2(#aws). Build an AWS image
 121
 122 <notextile><pre><code>~$ <span class="userinput">./build.sh --json-file arvados-images-aws.json \
 123            --arvados-cluster-id ClusterID \
 124            --aws-profile AWSProfile \
 125            --aws-source-ami AMI \
 126            --aws-vpc-id VPC \
 127            --aws-subnet-id Subnet \
 128            --ssh_user admin \
 129            --resolver ResolverIP \
 130            --public-key-file ArvadosDispatchCloudPublicKeyPath
 131 </span>
 132 </code></pre></notextile>
 133
 134 For @ClusterID@, fill in your cluster ID. The @VPC@ and @Subnet@ should be configured for where you want the compute image to be generated and stored. The @AMI@ is the identifier for the base image to be used. Current AMIs are maintained by "Debian":https://wiki.debian.org/Cloud/AmazonEC2Image/Buster and "Ubuntu":https://cloud-images.ubuntu.com/locator/ec2/.
 135
 136 @AWSProfile@ should be replaced with the name of an AWS profile with sufficient permissions to create the image.
 137
 138 @ArvadosDispatchCloudPublicKeyPath@ should be replaced with the path to the ssh *public* key file generated in "Create an SSH keypair":#sshkeypair, above.
 139
 140 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. The IP address of the resolver should replace the string @ResolverIP@ in the command above.
 141
 142 Alternatively, the services could be hardcoded into an @/etc/hosts@ file. For example:
 143
 144 <notextile><pre><code>10.20.30.40     <span class="userinput">ClusterID.example.com</span>
 145 10.20.30.41     <span class="userinput">keep1.ClusterID.example.com</span>
 146 10.20.30.42     <span class="userinput">keep2.ClusterID.example.com</span>
 147 </code></pre></notextile>
 148
 149 Adding these lines to the @/etc/hosts@ file in the compute node image could be done with a small change to the Packer template and the @scripts/base.sh@ script, which will be left as an exercise for the reader.
 150
 151 h2(#azure). Build an Azure image
 152
 153 <notextile><pre><code>~$ <span class="userinput">./build.sh --json-file arvados-images-azure.json \
 154            --arvados-cluster-id ClusterID \
 155            --azure-resource-group ResourceGroup \
 156            --azure-location AzureRegion \
 157            --azure-sku AzureSKU \
 158            --azure-secrets-file AzureSecretsFilePath \
 159            --resolver ResolverIP \
 160            --public-key-file ArvadosDispatchCloudPublicKeyPath
 161 </span>
 162 </code></pre></notextile>
 163
 164 For @ClusterID@, fill in your cluster ID. The @ResourceGroup@ and @AzureRegion@ (e.g. 'eastus2') should be configured for where you want the compute image to be generated and stored. The @AzureSKU@ is the SKU of the base image to be used, e.g. '18.04-LTS' for Ubuntu 18.04.
 165
 166 @AzureSecretsFilePath@ should be replaced with the path to a shell script that loads the Azure secrets with sufficient permissions to create the image. The file would look like this:
 167
 168 <notextile><pre><code>export ARM_CLIENT_ID=...
 169 export ARM_CLIENT_SECRET=...
 170 export ARM_SUBSCRIPTION_ID=...
 171 export ARM_TENANT_ID=...
 172 </code></pre></notextile>
 173
 174 These secrets can be generated from the Azure portal, or with the cli using a command like this:
 175
 176 <notextile><pre><code>~$ <span class="userinput">az ad sp create-for-rbac --name Packer --password ...</span>
 177 </code></pre></notextile>
 178
 179 @ArvadosDispatchCloudPublicKeyPath@ should be replaced with the path to the ssh *public* key file generated in "Create an SSH keypair":#sshkeypair, above.
 180
 181 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. The IP address of the resolver should replace the string @ResolverIP@ in the command above.
 182
 183 Alternatively, the services could be hardcoded into an @/etc/hosts@ file. For example:
 184
 185 <notextile><pre><code>10.20.30.40     <span class="userinput">ClusterID.example.com</span>
 186 10.20.30.41     <span class="userinput">keep1.ClusterID.example.com</span>
 187 10.20.30.42     <span class="userinput">keep2.ClusterID.example.com</span>
 188 </code></pre></notextile>
 189
 190 Adding these lines to the @/etc/hosts@ file in the compute node image could be done with a small change to the Packer template and the @scripts/base.sh@ script, which will be left as an exercise for the reader.