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 # "Hosts preparation":#hosts_preparation
14 ## "Hosts setup using terraform (experimental)":#hosts_setup_using_terraform
15 ## "Create a compute image":#create_a_compute_image
16 # "Multi host install using the provision.sh script":#multi_host
17 # "Choose the desired configuration":#choose_configuration
18 ## "Multiple hosts / multiple hostnames":#multi_host_multi_hostnames
19 ## "Further customization of the installation (modifying the salt pillars and states)":#further_customization
20 # "Installation order":#installation_order
21 # "Run the provision.sh script":#run_provision_script
22 # "Initial user and login":#initial_user
23 # "Test the installed cluster running a simple workflow":#test_install
27 h2(#introduction). Introduction
29 Arvados components can be installed in a distributed infrastructure, whether it is an "on-prem" with physical or virtual hosts, or a cloud environment.
31 As infrastructures vary a great deal from site to site, these instructions should be considered more as 'guidelines' than fixed steps to follow.
33 We provide an "installer script":salt.html that can help you deploy the different Arvados components. At the time of writing, the provided examples are suitable to install Arvados on AWS.
37 h2(#hosts_preparation). Hosts preparation
39 In order to run Arvados on a multi-host installation, there are a few requirements that your infrastructure has to fulfill.
41 These instructions explain how to setup a multi-host environment that is suitable for production use of Arvados.
43 We suggest distributing the Arvados components in the following way, creating at least 6 hosts:
51 ## arvados cloud dispatcher
59 # KEEPSTOREs (at least 2)
61 # SHELL node (optional):
64 Note that these hosts can be virtual machines in your infrastructure and they don't need to be physical machines.
66 Again, 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.
69 h3(#hosts_setup_using_terraform). Hosts setup using terraform (AWS, experimental)
71 We added a few "terraform":https://terraform.io/ scripts (https://github.com/arvados/arvados/tree/main/tools/terraform) to let you create these instances easier in an AWS account. Check "the Arvados terraform documentation":/doc/install/terraform.html for more details.
76 h2(#multi_host). Multi host install using the provision.sh script
78 {% include 'branchname' %}
80 This is a package-based installation method. Start with the @provision.sh@ script which is available by cloning the @{{ branchname }}@ branch from "https://git.arvados.org/arvados.git":https://git.arvados.org/arvados.git . The @provision.sh@ script and its supporting files can be found in the "arvados/tools/salt-install":https://git.arvados.org/arvados.git/tree/refs/heads/{{ branchname }}:/tools/salt-install directory in the Arvados git repository.
82 This procedure will install all the main Arvados components to get you up and running in a multi-host environment.
84 The @provision.sh@ script will help you deploy Arvados by preparing your environment to be able to run the installer, then running it. The actual installer is located at "arvados-formula":https://git.arvados.org/arvados-formula.git/tree/refs/heads/{{ branchname }} and will be cloned during the running of the @provision.sh@ script. The installer is built using "Saltstack":https://saltproject.io/ and @provision.sh@ performs the install using master-less mode.
86 After setting up a few variables in a config file (next step), you'll be ready to run it and get Arvados deployed.
88 h3(#create_a_compute_image). Create a compute image
90 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 can use the image ID in the Arvados configuration in the next steps.
92 h2(#choose_configuration). Choose the desired configuration
94 For documentation's sake, we will use the cluster name <i>arva2</i> and the domain <i>arv.local</i>. If you don't change them as required in the next steps, installation won't proceed.
96 We will try to provide a few Arvados' multi host installation configurations examples for different infrastructure providers. Currently only AWS is available but they can be used with almost any provider with little changes.
98 You need to copy one of the example configuration files and directory, and edit them to suit your needs.
100 h3(#multi_host_multi_hostnames). Multiple hosts / multiple hostnames
102 <pre><code>cp local.params.example.multiple_hosts local.params
103 cp -r config_examples/multi_host/aws local_config_dir
107 Edit the variables in the <i>local.params</i> file. Pay attention to the <b>*_INT_IP, *_TOKEN</b> and <b>*KEY</b> variables. Those variables will be used to do a search and replace on the <i>pillars/*</i> in place of any matching __VARIABLE__.
109 The <i>multi_host</i> include LetsEncrypt salt code to automatically request and install the certificates for the public-facing hosts (API/controller, Workbench, Keepproxy/Keepweb) using AWS' Route53. If you will provide custom certificates, please set the variable <i>USE_LETSENCRYPT=no</i>.
111 h3(#further_customization). Further customization of the installation (modifying the salt pillars and states)
113 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 can be retrieved as output of the terraform run.
115 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.
117 h2(#installation_order). Installation order
119 A few Arvados nodes need to be installed in certain order. The required order is
123 #. The other nodes can be installed in any order after the two above
125 h2(#run_provision_script). Run the provision.sh script
127 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:
130 <pre><code>scp -r provision.sh local* user@host:
131 ssh user@host sudo ./provision.sh --roles comma,separated,list,of,roles,to,apply
135 and wait for it to finish.
137 If everything goes OK, you'll get some final lines stating something like:
140 <pre><code>arvados: Succeeded: 109 (changed=9)
145 The distribution of role as described above can be applied running these commands:
149 <pre><code>scp -r provision.sh local* user@host:
150 ssh user@host sudo ./provision.sh --config local.params --roles database
156 <pre><code>scp -r provision.sh local* user@host:
157 ssh user@host sudo ./provision.sh --config local.params --roles api,controller,websocket,dispatcher
163 <pre><code>scp -r provision.sh local* user@host:
164 ssh user@host sudo ./provision.sh --config local.params --roles keepstore
170 <pre><code>scp -r provision.sh local* user@host:
171 ssh user@host sudo ./provision.sh --config local.params --roles workbench,workbench2,webshell
175 #. Keepproxy / Keepweb
177 <pre><code>scp -r provision.sh local* user@host:
178 ssh user@host sudo ./provision.sh --config local.params --roles keepproxy,keepweb
182 #. Shell (here we copy the CLI test workflow too)
184 <pre><code>scp -r provision.sh local* tests user@host:
185 ssh user@host sudo ./provision.sh --config local.params --roles shell
189 h2(#initial_user). Initial user and login
191 At this point you should be able to log into the Arvados cluster. The initial URL will be:
193 * https://workbench.arva2.arv.local
195 or, in general, the url format will be:
197 * https://workbench.@<cluster>.<domain>@
199 By default, the provision script creates an initial user for testing purposes. This user is configured as administrator of the newly created cluster.
201 Assuming you didn't change these values in the @local.params@ file, the initial credentials are:
204 * Password: 'password'
205 * Email: 'admin@arva2.arv.local'
207 h2(#test_install). Test the installed cluster running a simple workflow
209 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:
212 <pre><code>cd /tmp/cluster_tests
217 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):
220 <pre><code>Creating Arvados Standard Docker Images project
221 Arvados project uuid is 'arva2-j7d0g-0prd8cjlk6kfl7y'
224 "uuid":"arva2-o0j2j-n4zu4cak5iifq2a",
225 "owner_uuid":"arva2-tpzed-000000000000000",
228 Uploading arvados/jobs' docker image to the project
229 2.1.1: Pulling from arvados/jobs
230 8559a31e96f4: Pulling fs layer
232 Status: Downloaded newer image for arvados/jobs:2.1.1
233 docker.io/arvados/jobs:2.1.1
234 2020-11-23 21:43:39 arvados.arv_put[32678] INFO: Creating new cache file at /home/vagrant/.cache/arvados/arv-put/c59256eda1829281424c80f588c7cc4d
235 2020-11-23 21:43:46 arvados.arv_put[32678] INFO: Collection saved as 'Docker image arvados jobs:2.1.1 sha256:0dd50'
236 arva2-4zz18-1u5pvbld7cvxuy2
237 Creating initial user ('admin')
238 Setting up user ('admin')
243 "owner_uuid":"arva2-tpzed-000000000000000",
245 "uuid":"arva2-o0j2j-1ownrdne0ok9iox"
249 "owner_uuid":"arva2-tpzed-000000000000000",
251 "uuid":"arva2-o0j2j-1zbeyhcwxc1tvb7"
255 "email":"admin@arva2.arv.local",
257 "owner_uuid":"arva2-tpzed-000000000000000",
260 "uuid":"arva2-tpzed-3wrm93zmzpshrq2",
264 "kind":"arvados#HashList"
266 Activating user 'admin'
269 "email":"admin@arva2.arv.local",
272 "uuid":"arva2-tpzed-3wrm93zmzpshrq2",
275 Running test CWL workflow
276 INFO /usr/bin/cwl-runner 2.1.1, arvados-python-client 2.1.1, cwltool 3.0.20200807132242
277 INFO Resolved 'hasher-workflow.cwl' to 'file:///tmp/cluster_tests/hasher-workflow.cwl'
279 INFO Using cluster arva2 (https://arva2.arv.local:8443/)
280 INFO Upload local files: "test.txt"
281 INFO Uploaded to ea34d971b71d5536b4f6b7d6c69dc7f6+50 (arva2-4zz18-c8uvwqdry4r8jao)
282 INFO Using collection cache size 256 MiB
283 INFO [container hasher-workflow.cwl] submitted container_request arva2-xvhdp-v1bkywd58gyocwm
284 INFO [container hasher-workflow.cwl] arva2-xvhdp-v1bkywd58gyocwm is Final
285 INFO Overall process status is success
286 INFO Final output collection d6c69a88147dde9d52a418d50ef788df+123
289 "basename": "hasher3.md5sum.txt",
291 "location": "keep:d6c69a88147dde9d52a418d50ef788df+123/hasher3.md5sum.txt",
295 INFO Final process status is success