3 navsection: installguide
4 title: Single host Arvados
7 Copyright (C) The Arvados Authors. All rights reserved.
9 SPDX-License-Identifier: CC-BY-SA-3.0
12 # "Limitations of the single host install":#limitations
13 # "Prerequisites":#prerequisites
14 # "Single host install using the provision.sh script":#single_host
15 # "Choose the desired configuration":#choose_configuration
16 ## "Single host / single hostname":#single_host_single_hostname
17 ## "Single host / multiple hostnames (Alternative configuration)":#single_host_multiple_hostnames
18 ## "Further customization of the installation (modifying the salt pillars and states)":#further_customization
19 # "Run the provision.sh script":#run_provision_script
20 # "Final configuration steps":#final_steps
21 ## "Install the CA root certificate (required in both alternatives)":#ca_root_certificate
22 ## "DNS configuration (single host / multiple hostnames)":#single_host_multiple_hostnames_dns_configuration
23 # "Initial user and login":#initial_user
24 # "Test the installed cluster running a simple workflow":#test_install
25 # "After the installation":#post_install
27 h2(#limitations). Limitations of the single host install
29 <b>NOTE: The single host installation is a good choice for evaluating Arvados, but it is not recommended for production use.</b>
31 Using the default configuration, this installation method has a number of limitations:
33 * all services run on the same machine, and they will compete for resources. This includes any compute jobs.
34 * it uses the local machine disk for Keep storage (under the @/tmp@ directory). There may not be a lot of space available.
35 * it installs the @crunch-dispatch-local@ dispatcher, which can run just eight concurrent CWL jobs. These jobs will be executed on the same machine that runs all the Arvados services and may well starve them of resources.
37 It is possible to start with the single host installation method and modify the Arvados configuration file later to address these limitations. E.g. switch to a "different storage volume setup":{{site.baseurl}}/install/configure-s3-object-storage.html for Keep, and switch to "the cloud dispatcher":{{site.baseurl}}/install/crunch2-cloud/install-dispatch-cloud.html to provision compute resources dynamically.
39 h2(#prerequisites). Prerequisites and planning
41 Arvados requires SSL for (almost) all network traffic. This installation method supports the following options for the required SSL certificate(s): @self-signed@ and @bring your own certificates@.
46 * a dedicated (virtual) machine for your Arvados server with at least 2 cores and 8 GiB of RAM, running a "supported Arvados distribution":{{site.baseurl}}/install/install-manual-prerequisites.html#supportedlinux
47 * ports 9443-9445, 11002, 14202, 18002, 35101 need to be reachable from your client (configurable, see below)
48 * at least one DNS hostname that resolves to the IP address of your Arvados server
49 * one or more SSL certificates matching the hostname(s) in use (only when using @bring your own certificates@)
51 h2(#single_host). Single host install using the provision.sh script
53 {% include 'branchname' %}
55 This procedure will install all the main Arvados components to get you up and running in a single host. The whole installation procedure takes somewhere between 15 to 60 minutes, depending on the host resources and its network bandwidth. As a reference, on a virtual machine with 1 core and 1 GB RAM, it takes ~25 minutes to do the initial install.
57 This is a package-based installation method, however the installation script is currently distributed in source form via @git@:
60 <pre><code>git clone https://git.arvados.org/arvados.git
61 git checkout {{ branchname }}
62 cd arvados/tools/salt-install
66 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.
68 After setting up a few variables in a config file (next step), you'll be ready to run it and get Arvados deployed.
70 h2(#choose_configuration). Choose the desired configuration
72 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.
74 Arvados' single host installation can be done in two fashions:
76 * Using a single hostname, assigning <i>a different port (other than 443) for each user-facing service</i>: This choice is easier to setup, but the user will need to know the port/s for the different services she wants to connect to.
77 * Using multiple hostnames on the same IP: this setup involves a few extra steps but each service will have a meaningful hostname so it will make easier to access them later.
79 Once you decide which of these choices you prefer, copy one the two example configuration files and directory, and edit them to suit your needs.
81 h3(#single_host_single_hostname). Single host / single hostname
83 <pre><code>cp local.params.example.single_host_single_hostname local.params
84 cp -r config_examples/single_host/single_hostname local_config_dir
88 Edit the variables in the <i>local.params</i> file. Pay attention to the <b>*_PORT, *_TOKEN</b> and <b>*KEY</b> variables.
90 The <i>single_host</i> examples use self-signed SSL certificates by default, which are deployed using the same mechanism used to deploy custom certificates.
92 When setting (SSL_MODE=lets-encrypt), please note: When using AWS, EC2 instances can have a default hostname that ends with `amazonaws.com`. Let's Encrypt has a blacklist of domain names for which it will not issue certificates, and that blacklist includes the `amazonaws.com` domain. In order to use Let's Encrypt certificates on AWS EC2, you will need to bring your own domain name and point a hostname in that domain at your EC2 instance.
94 h3(#single_host_multiple_hostnames). Single host / multiple hostnames (Alternative configuration)
96 <pre><code>cp local.params.example.single_host_multiple_hostnames local.params
97 cp -r config_examples/single_host/multiple_hostnames local_config_dir
101 Edit the variables in the <i>local.params</i> file.
103 {% include 'install_custom_certificates' %}
105 h3(#further_customization). Further customization of the installation (modifying the salt pillars and states)
107 If you want or need further customization, you can edit the Saltstack pillars and states files. Pay particular attention to the <i>pillars/arvados.sls</i> one. 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 host.
109 h2(#run_provision_script). Run the provision.sh script
111 When you finished customizing the configuration, you are ready to copy the files to the host (if needed) and run the @provision.sh@ script:
114 <pre><code>scp -r provision.sh local* tests user@host:
115 # if you are using bring-your-own certificates, make sure to copy those too:
116 # scp -r certs user@host:
117 ssh user@host sudo ./provision.sh
121 or, if you saved the @local.params@ in another directory or with some other name
124 <pre><code>scp -r provision.sh local* tests user@host:
125 ssh user@host sudo ./provision.sh -c /path/to/your/local.params.file
129 and wait for it to finish.
131 If everything goes OK, you'll get some final lines stating something like:
134 <pre><code>arvados: Succeeded: 109 (changed=9)
139 h2(#final_steps). Final configuration steps
141 Once the deployment went OK, you'll need to perform a few extra steps in your local browser/host to access the cluster.
143 h3(#ca_root_certificate). Install the CA root certificate (SSL_MODE=self-signed only)
145 Arvados uses SSL to encrypt communications. Its UI uses AJAX which will silently fail if the certificate is not valid or signed by an unknown Certification Authority.
147 For this reason, the @arvados-formula@ has a helper state to create a root certificate to authorize Arvados services. The @provision.sh@ script will leave a copy of the generated CA's certificate (@arvados-snakeoil-ca.pem@) in the script's directory so you can add it to your workstation.
149 Installing the root certificate into your web browser will prevent security errors when accessing Arvados services with your web browser.
151 # Go to the certificate manager in your browser.
152 #* In Chrome, this can be found under "Settings → Advanced → Manage Certificates" or by entering @chrome://settings/certificates@ in the URL bar.
153 #* In Firefox, this can be found under "Preferences → Privacy & Security" or entering @about:preferences#privacy@ in the URL bar and then choosing "View Certificates...".
154 # Select the "Authorities" tab, then press the "Import" button. Choose @arvados-snakeoil-ca.pem@
156 The certificate will be added under the "Arvados Formula".
158 To access your Arvados instance using command line clients (such as arv-get and arv-put) without security errors, install the certificate into the OS certificate storage.
163 <pre><code>cp arvados-root-cert.pem /usr/local/share/ca-certificates/
164 /usr/sbin/update-ca-certificates
171 <pre><code>cp arvados-root-cert.pem /etc/pki/ca-trust/source/anchors/
172 /usr/bin/update-ca-trust
176 h3(#single_host_multiple_hostnames_dns_configuration). DNS configuration (single host / multiple hostnames)
178 When using multiple hostnames, after the setup is done, you need to set up your DNS to be able to access the cluster.
180 If you don't have access to the domain's DNS to add the required entries, the simplest way to do it is to edit your @/etc/hosts@ file (as root):
183 <pre><code>export CLUSTER="arva2"
184 export DOMAIN="arv.local"
185 export HOST_IP="127.0.0.2" # This is valid either if installing in your computer directly
186 # or in a Vagrant VM. If you're installing it on a remote host
187 # just change the IP to match that of the host.
188 echo "${HOST_IP} api keep keep0 collections download ws workbench workbench2 ${CLUSTER}.${DOMAIN} api.${CLUSTER}.${DOMAIN} keep.${CLUSTER}.${DOMAIN} keep0.${CLUSTER}.${DOMAIN} collections.${CLUSTER}.${DOMAIN} download.${CLUSTER}.${DOMAIN} ws.${CLUSTER}.${DOMAIN} workbench.${CLUSTER}.${DOMAIN} workbench2.${CLUSTER}.${DOMAIN}" >> /etc/hosts
192 h2(#initial_user). Initial user and login
194 At this point you should be able to log into the Arvados cluster. The initial URL will be:
196 * https://workbench.arva2.arv.local
198 or, in general, the url format will be:
200 * https://workbench.@<cluster>.<domain>@
202 By default, the provision script creates an initial user for testing purposes. This user is configured as administrator of the newly created cluster.
204 Assuming you didn't change these values in the @local.params@ file, the initial credentials are:
207 * Password: 'password'
208 * Email: 'admin@arva2.arv.local'
210 h2(#test_install). Test the installed cluster running a simple workflow
212 The @provision.sh@ script saves a simple example test workflow in the @/tmp/cluster_tests@ directory in the node. If you want to run it, just ssh to the node, change to that directory and run:
215 <pre><code>cd /tmp/cluster_tests
220 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):
223 <pre><code>Creating Arvados Standard Docker Images project
224 Arvados project uuid is 'arva2-j7d0g-0prd8cjlk6kfl7y'
227 "uuid":"arva2-o0j2j-n4zu4cak5iifq2a",
228 "owner_uuid":"arva2-tpzed-000000000000000",
231 Uploading arvados/jobs' docker image to the project
232 2.1.1: Pulling from arvados/jobs
233 8559a31e96f4: Pulling fs layer
235 Status: Downloaded newer image for arvados/jobs:2.1.1
236 docker.io/arvados/jobs:2.1.1
237 2020-11-23 21:43:39 arvados.arv_put[32678] INFO: Creating new cache file at /home/vagrant/.cache/arvados/arv-put/c59256eda1829281424c80f588c7cc4d
238 2020-11-23 21:43:46 arvados.arv_put[32678] INFO: Collection saved as 'Docker image arvados jobs:2.1.1 sha256:0dd50'
239 arva2-4zz18-1u5pvbld7cvxuy2
240 Creating initial user ('admin')
241 Setting up user ('admin')
246 "owner_uuid":"arva2-tpzed-000000000000000",
248 "uuid":"arva2-o0j2j-1ownrdne0ok9iox"
252 "owner_uuid":"arva2-tpzed-000000000000000",
254 "uuid":"arva2-o0j2j-1zbeyhcwxc1tvb7"
258 "email":"admin@arva2.arv.local",
260 "owner_uuid":"arva2-tpzed-000000000000000",
263 "uuid":"arva2-tpzed-3wrm93zmzpshrq2",
267 "kind":"arvados#HashList"
269 Activating user 'admin'
272 "email":"admin@arva2.arv.local",
275 "uuid":"arva2-tpzed-3wrm93zmzpshrq2",
278 Running test CWL workflow
279 INFO /usr/bin/cwl-runner 2.1.1, arvados-python-client 2.1.1, cwltool 3.0.20200807132242
280 INFO Resolved 'hasher-workflow.cwl' to 'file:///tmp/cluster_tests/hasher-workflow.cwl'
282 INFO Using cluster arva2 (https://arva2.arv.local:8443/)
283 INFO Upload local files: "test.txt"
284 INFO Uploaded to ea34d971b71d5536b4f6b7d6c69dc7f6+50 (arva2-4zz18-c8uvwqdry4r8jao)
285 INFO Using collection cache size 256 MiB
286 INFO [container hasher-workflow.cwl] submitted container_request arva2-xvhdp-v1bkywd58gyocwm
287 INFO [container hasher-workflow.cwl] arva2-xvhdp-v1bkywd58gyocwm is Final
288 INFO Overall process status is success
289 INFO Final output collection d6c69a88147dde9d52a418d50ef788df+123
292 "basename": "hasher3.md5sum.txt",
294 "location": "keep:d6c69a88147dde9d52a418d50ef788df+123/hasher3.md5sum.txt",
298 INFO Final process status is success
302 h2(#post_install). After the installation
304 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.
306 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.