3 navsection: installguide
4 title: Build a cloud compute node image
7 Copyright (C) The Arvados Authors. All rights reserved.
9 SPDX-License-Identifier: CC-BY-SA-3.0
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' %}
16 # "Introduction":#introduction
17 # "Create an SSH keypair":#sshkeypair
18 # "The build script":#building
19 # "Build an Azure image":#azure
20 # "Build an AWS image":#aws
22 h2(#introduction). Introduction
24 This page describes how to build a compute node image that can be used to run containers dispatched by Arvados in the cloud.
26 Packer templates for AWS and Azure are provided with Arvados. To use them, the following are needed:
28 * "Packer":https://www.packer.io/
29 * credentials for your cloud account
30 * configuration details for your cloud account
33 h2(#sshkeypair). Create a SSH keypair
35 @arvados-dispatch-cloud@ communicates with the compute nodes via SSH. To do this securely, a SSH keypair is needed.
37 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.
40 <pre><code>~$ <span class="userinput">ssh-keygen -N '' -f ~/.ssh/id_dispatcher</span>
41 Generating public/private rsa key pair.
42 Your identification has been saved in /home/user/.ssh/id_dispatcher.
43 Your public key has been saved in /home/user/.ssh/id_dispatcher.pub.
44 The key fingerprint is:
46 ~$ <span class="userinput">cat ~/.ssh/id_dispatcher</span>
47 -----BEGIN RSA PRIVATE KEY-----
48 MIIEpQIBAAKCAQEAqXoCzcOBkFQ7w4dvXf9B++1ctgZRqEbgRYL3SstuMV4oawks
49 ttUuxJycDdsPmeYcHsKo8vsEZpN6iYsX6ZZzhkO5nEayUTU8sBjmg1ZCTo4QqKXr
51 oFyAjVoexx0RBcH6BveTfQtJKbktP1qBO4mXo2dP0cacuZEtlAqW9Eb06Pvaw/D9
52 foktmqOY8MyctzFgXBpGTxPliGjqo8OkrOyQP2g+FL7v+Km31Xs61P8=
53 -----END RSA PRIVATE KEY-----
57 h2(#building). The build script
59 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:
61 <notextile><pre><code>~$ <span class="userinput">./build.sh --help</span>
62 build.sh: Build cloud images for arvados-dispatch-cloud
69 --json-file (required)
70 Path to the packer json file
71 --arvados-cluster-id (required)
72 The ID of the Arvados cluster, e.g. zzzzz
73 --aws-profile (default: false)
74 AWS profile to use (valid profile from ~/.aws/config
75 --aws-secrets-file (default: false, required if building for AWS)
76 AWS secrets file which will be sourced from this script
77 --aws-source-ami (default: false, required if building for AWS)
78 The AMI to use as base for building the images
79 --aws-region (default: us-east-1)
80 The AWS region to use for building the images
81 --aws-vpc-id (optional)
82 VPC id for AWS, otherwise packer will pick the default one
84 Subnet id for AWS otherwise packer will pick the default one for the VPC
85 --gcp-project-id (default: false, required if building for GCP)
87 --gcp-account-file (default: false, required if building for GCP)
89 --gcp-zone (default: us-central1-f)
91 --azure-secrets-file (default: false, required if building for Azure)
92 Azure secrets file which will be sourced from this script
93 --azure-resource-group (default: false, required if building for Azure)
95 --azure-storage-account (default: false, required if building for Azure)
97 --azure-location (default: false, required if building for Azure)
98 Azure location, e.g. centralus, eastus, westeurope
99 --azure-sku (default: unset, required if building for Azure, e.g. 16.04-LTS)
100 Azure SKU image to use
101 --ssh_user (default: packer)
102 The user packer will use lo log into the image
103 --domain (default: arvadosapi.com)
104 The domain part of the FQDN for the cluster
105 --resolver (default: 8.8.8.8)
106 The dns resolver for the machine
107 --reposuffix (default: unset)
108 Set this to "-dev" to track the unstable/dev Arvados repositories
109 --public-key-file (required)
110 Path to the public key file that a-d-c will use to log into the compute node
112 Output debug information (default: false)
113 </code></pre></notextile>
115 h2(#azure). Build an Azure image
117 <notextile><pre><code>~$ <span class="userinput">./build.sh --json-file arvados-images-azure.json \
118 --arvados-cluster-id ClusterID \
119 --azure-resource-group ResourceGroup \
120 --azure-storage-account StorageAccount \
121 --azure-location AzureRegion \
122 --azure-sku AzureSKU \
123 --azure-secrets-file AzureSecretsFilePath \
124 --resolver ResolverIP \
125 --public-key-file ArvadosDispatchCloudPublicKeyPath
127 </code></pre></notextile>
129 For @ClusterID@, fill in your cluster ID. The @ResourceGroup@, @StorageAccount@ 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.
131 @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:
133 <notextile><pre><code>export ARM_CLIENT_ID=...
134 export ARM_CLIENT_SECRET=...
135 export ARM_SUBSCRIPTION_ID=...
136 export ARM_TENANT_ID=...
137 </code></pre></notextile>
139 These secrets can be generated from the Azure portal, or with the cli using a command like this:
141 <notextile><pre><code>~$ <span class="userinput">az ad sp create-for-rbac --name Packer --password ...</span>
142 </code></pre></notextile>
144 @ArvadosDispatchCloudPublicKeyPath@ should be replaced with the path to the ssh *public* key file generated in "Create an SSH keypair":#sshkeypair, above.
146 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.
148 Alternatively, the services could be hardcoded into an @/etc/hosts@ file. For example:
150 <notextile><pre><code>10.20.30.40 <span class="userinput">ClusterID.example.com</span>
151 10.20.30.41 <span class="userinput">keep1.ClusterID.example.com</span>
152 10.20.30.42 <span class="userinput">keep2.ClusterID.example.com</span>
153 </code></pre></notextile>
155 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.
157 h2(#aws). Build an AWS image
159 <notextile><pre><code>~$ <span class="userinput">./build.sh --json-file arvados-images-aws.json \
160 --arvados-cluster-id ClusterID \
161 --aws-profile AWSProfile \
162 --aws-source-ami AMI \
164 --aws-subnet-id Subnet \
166 --resolver ResolverIP \
167 --public-key-file ArvadosDispatchCloudPublicKeyPath
169 </code></pre></notextile>
171 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/.
173 @AWSProfile@ should be replaced with the name of an AWS profile with sufficient permissions to create the image.
175 @ArvadosDispatchCloudPublicKeyPath@ should be replaced with the path to the ssh *public* key file generated in "Create an SSH keypair":#sshkeypair, above.
177 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.
179 Alternatively, the services could be hardcoded into an @/etc/hosts@ file. For example:
181 <notextile><pre><code>10.20.30.40 <span class="userinput">ClusterID.example.com</span>
182 10.20.30.41 <span class="userinput">keep1.ClusterID.example.com</span>
183 10.20.30.42 <span class="userinput">keep2.ClusterID.example.com</span>
184 </code></pre></notextile>
186 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.