3 navsection: installguide
4 title: Multi host Arvados
7 Copyright (C) The Arvados Authors. All rights reserved.
9 SPDX-License-Identifier: CC-BY-SA-3.0
12 # "Introduction":#introduction
13 # "Prerequisites and planning":#prerequisites
14 # "Download the installer":#download
15 # "Copy the configuration files":#copy_config
16 # "Choose the SSL configuration":#certificates
17 ## "Using a self-signed certificates":#self-signed
18 ## "Using a Let's Encrypt certificates":#lets-encrypt
19 ## "Bring your own certificates":#bring-your-own
20 # "Create a compute image":#create_a_compute_image
21 # "Further customization of the installation (modifying the salt pillars and states)":#further_customization
22 # "Installation order":#installation_order
23 # "Run the provision.sh script":#run_provision_script
24 # "Install the CA root certificate":#ca_root_certificate
25 # "Initial user and login":#initial_user
26 # "Test the installed cluster running a simple workflow":#test_install
27 # "After the installation":#post_install
29 h2(#introduction). Introduction
31 This multi host installer is an AWS specific example that is generally useful, but will likely need to be adapted for your environment. The installer is highly configurable.
33 h2(#prerequisites). Prerequisites and planning
38 * a number of (virtual) machines for your Arvados cluster with at least 2 cores and 8 GiB of RAM, running a "supported Arvados distribution":{{site.baseurl}}/install/install-manual-prerequisites.html#supportedlinux
39 * a number of DNS hostnames that resolve to the IP addresses of your Arvados hosts
40 * ports 443 need to be reachable from your client (configurable in @local.params@, see below)
41 * port 80 needs to be reachable from everywhere on the internet (only when using "Let's Encrypt":#lets-encrypt without Route53 integration)
42 * SSL certificatse matching the hostnames in use (only when using "bring your own certificates":#bring-your-own)
46 We suggest distributing the Arvados components in the following way, creating at least 6 hosts:
54 ## arvados cloud dispatcher
55 ## arvados keepbalance
63 # KEEPSTORE nodes (at least 2)
65 # SHELL node (optional):
68 If your infrastructure differs from the setup proposed above (ie, using RDS or an existing DB server), remember that you will need to edit the configuration files for the scripts so they work with your infrastructure.
70 h2(#download). Download the installer
72 {% include 'download_installer' %}
74 h2(#copy_config). Copy the configuration files
77 <pre><code>cp local.params.example.multiple_hosts local.params
78 cp -r config_examples/multi_host/aws local_config_dir
82 Edit the variables in the <i>local.params</i> file. Pay attention to the <notextile><b>*_INT_IP, *_TOKEN</b> and <b>*_KEY</b></notextile> variables. The *SSL_MODE* variable is discussed in the next section.
84 {% include 'ssl_config_multi' %}
86 h3(#create_a_compute_image). Create a compute image
88 In a multi-host installation, containers are dispatched in docker daemons running in the <i>compute instances</i>, which need some special setup. We provide a "compute image builder script":https://github.com/arvados/arvados/tree/main/tools/compute-images that you can use to build a template image following "these instructions":https://doc.arvados.org/main/install/crunch2-cloud/install-compute-node.html. Once you have that image created, you will need to update the <i>pillars/arvados.sls</i> file with the AMI ID and the private ssh key for the dispatcher.
90 h3(#further_customization). Further customization of the installation (modifying the salt pillars and states)
92 You will need further customization to suit your environment, which can be done editing the Saltstack pillars and states files. Pay particular attention to the <i>pillars/arvados.sls</i> file, where you will need to provide some information that describes your environment.
94 Any extra <i>state</i> file you add under <i>local_config_dir/states</i> will be added to the salt run and applied to the hosts.
96 h2(#installation_order). Installation order
98 A few Arvados nodes need to be installed in certain order. The required order is
102 * The other nodes can be installed in any order after the two above
104 h2(#run_provision_script). Run the provision.sh script
106 When you finished customizing the configuration, you are ready to copy the files to the hosts and run the @provision.sh@ script. The script allows you to specify the <i>role/s</i> a node will have and it will install only the Arvados components required for such role. The general format of the command is:
109 <pre><code>scp -r provision.sh local* user@host:
110 ssh user@host sudo ./provision.sh --roles comma,separated,list,of,roles,to,apply
114 and wait for it to finish.
116 If everything goes OK, you'll get some final lines stating something like:
119 <pre><code>arvados: Succeeded: 109 (changed=9)
124 The distribution of role as described above can be applied running these commands:
128 <pre><code>scp -r provision.sh local* user@host:
129 ssh user@host sudo ./provision.sh --config local.params --roles database
135 <pre><code>scp -r provision.sh local* user@host:
136 ssh user@host sudo ./provision.sh --config local.params --roles api,controller,websocket,dispatcher,keepbalance
142 <pre><code>scp -r provision.sh local* user@host:
143 ssh user@host sudo ./provision.sh --config local.params --roles keepstore
149 <pre><code>scp -r provision.sh local* user@host:
150 ssh user@host sudo ./provision.sh --config local.params --roles workbench,workbench2,webshell
154 h4. Keepproxy / Keepweb
156 <pre><code>scp -r provision.sh local* user@host:
157 ssh user@host sudo ./provision.sh --config local.params --roles keepproxy,keepweb
161 h4. Shell (here we copy the CLI test workflow too)
163 <pre><code>scp -r provision.sh local* tests user@host:
164 ssh user@host sudo ./provision.sh --config local.params --roles shell
168 {% include 'install_ca_cert' %}
170 h2(#initial_user). Initial user and login
172 At this point you should be able to log into the Arvados cluster. The initial URL will be:
174 * https://workbench.arva2.arv.local
176 or, in general, the url format will be:
178 * https://workbench.@<cluster>.<domain>@
180 By default, the provision script creates an initial user for testing purposes. This user is configured as administrator of the newly created cluster.
182 Assuming you didn't change these values in the @local.params@ file, the initial credentials are:
185 * Password: 'password'
186 * Email: 'admin@arva2.arv.local'
188 h2(#test_install). Test the installed cluster running a simple workflow
190 If you followed the instructions above, the @provision.sh@ script saves a simple example test workflow in the @/tmp/cluster_tests@ directory in the @shell@ node. If you want to run it, just ssh to the node, change to that directory and run:
193 <pre><code>cd /tmp/cluster_tests
198 It will create a test user (by default, the same one as the admin user), upload a small workflow and run it. If everything goes OK, the output should similar to this (some output was shortened for clarity):
201 <pre><code>Creating Arvados Standard Docker Images project
202 Arvados project uuid is 'arva2-j7d0g-0prd8cjlk6kfl7y'
205 "uuid":"arva2-o0j2j-n4zu4cak5iifq2a",
206 "owner_uuid":"arva2-tpzed-000000000000000",
209 Uploading arvados/jobs' docker image to the project
210 2.1.1: Pulling from arvados/jobs
211 8559a31e96f4: Pulling fs layer
213 Status: Downloaded newer image for arvados/jobs:2.1.1
214 docker.io/arvados/jobs:2.1.1
215 2020-11-23 21:43:39 arvados.arv_put[32678] INFO: Creating new cache file at /home/vagrant/.cache/arvados/arv-put/c59256eda1829281424c80f588c7cc4d
216 2020-11-23 21:43:46 arvados.arv_put[32678] INFO: Collection saved as 'Docker image arvados jobs:2.1.1 sha256:0dd50'
217 arva2-4zz18-1u5pvbld7cvxuy2
218 Creating initial user ('admin')
219 Setting up user ('admin')
224 "owner_uuid":"arva2-tpzed-000000000000000",
226 "uuid":"arva2-o0j2j-1ownrdne0ok9iox"
230 "owner_uuid":"arva2-tpzed-000000000000000",
232 "uuid":"arva2-o0j2j-1zbeyhcwxc1tvb7"
236 "email":"admin@arva2.arv.local",
238 "owner_uuid":"arva2-tpzed-000000000000000",
241 "uuid":"arva2-tpzed-3wrm93zmzpshrq2",
245 "kind":"arvados#HashList"
247 Activating user 'admin'
250 "email":"admin@arva2.arv.local",
253 "uuid":"arva2-tpzed-3wrm93zmzpshrq2",
256 Running test CWL workflow
257 INFO /usr/bin/cwl-runner 2.1.1, arvados-python-client 2.1.1, cwltool 3.0.20200807132242
258 INFO Resolved 'hasher-workflow.cwl' to 'file:///tmp/cluster_tests/hasher-workflow.cwl'
260 INFO Using cluster arva2 (https://arva2.arv.local:8443/)
261 INFO Upload local files: "test.txt"
262 INFO Uploaded to ea34d971b71d5536b4f6b7d6c69dc7f6+50 (arva2-4zz18-c8uvwqdry4r8jao)
263 INFO Using collection cache size 256 MiB
264 INFO [container hasher-workflow.cwl] submitted container_request arva2-xvhdp-v1bkywd58gyocwm
265 INFO [container hasher-workflow.cwl] arva2-xvhdp-v1bkywd58gyocwm is Final
266 INFO Overall process status is success
267 INFO Final output collection d6c69a88147dde9d52a418d50ef788df+123
270 "basename": "hasher3.md5sum.txt",
272 "location": "keep:d6c69a88147dde9d52a418d50ef788df+123/hasher3.md5sum.txt",
276 INFO Final process status is success
280 h2(#post_install). After the installation
282 Once the installation is complete, it is recommended to keep a copy of your local configuration files. Committing them to version control is a good idea.
284 Re-running the Salt-based installer is not recommended for maintaining and upgrading Arvados, please see "Maintenance and upgrading":{{site.baseurl}}/admin/maintenance-and-upgrading.html for more information.