Merge branch 'master' into 16950-add-costanalyzer
[arvados.git] / doc / install / salt-single-host.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Single host Arvados
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 # "Install Saltstack":#saltstack
13 # "Single host install using the provision.sh script":#single_host
14 # "Local testing Arvados in a Vagrant box":#vagrant
15 # "DNS configuration":#final_steps
16 # "Initial user and login":#initial_user
17
18 h2(#saltstack). Install Saltstack
19
20 If you already have a Saltstack environment you can skip this section.
21
22 The simplest way to get Salt up and running on a node is to use the bootstrap script they provide:
23
24 <notextile>
25 <pre><code>curl -L https://bootstrap.saltstack.com -o /tmp/bootstrap_salt.sh
26 sudo sh /tmp/bootstrap_salt.sh -XUdfP -x python3
27 </code></pre>
28 </notextile>
29
30 For more information check "Saltstack's documentation":https://docs.saltstack.com/en/latest/topics/installation/index.html
31
32 h2(#single_host). Single host install using the provision.sh script
33
34 This is a package-based installation method. The Salt scripts are available from the "tools/salt-install":https://github.com/arvados/arvados/tree/master/tools/salt-install directory in the Arvados git repository.
35
36 Use the @provision.sh@ script to deploy Arvados, which is implemented with the @arvados-formula@ in a Saltstack master-less setup:
37
38 * edit the variables at the very beginning of the file,
39 * run the script as root
40 * wait for it to finish
41
42 This will install all the main Arvados components to get you up and running. The whole installation procedure takes somewhere between 15 to 60 minutes, depending on the host and your network bandwidth. On a virtual machine with 1 core and 1 GB RAM, it takes ~25 minutes to do the initial install.
43
44 If everything goes OK, you'll get some final lines stating something like:
45
46 <notextile>
47 <pre><code>arvados: Succeeded: 109 (changed=9)
48 arvados: Failed:      0
49 </code></pre>
50 </notextile>
51
52 h2(#final_steps). DNS configuration
53
54 After the setup is done, you need to set up your DNS to be able to access the cluster.
55
56 The simplest way to do this is to edit your @/etc/hosts@ file (as root):
57
58 <notextile>
59 <pre><code>export CLUSTER="arva2"
60 export DOMAIN="arv.local"
61 export HOST_IP="127.0.0.2"    # This is valid either if installing in your computer directly
62                               # or in a Vagrant VM. If you're installing it on a remote host
63                               # just change the IP to match that of the host.
64 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
65 </code></pre>
66 </notextile>
67
68 h2(#initial_user). Initial user and login
69
70 At this point you should be able to log into the Arvados cluster.
71
72 If you changed nothing in the @provision.sh@ script, the initial URL will be:
73
74 * https://workbench.arva2.arv.local
75
76 or, in general, the url format will be:
77
78 * https://workbench.@<cluster>.<domain>@
79
80 By default, the provision script creates an initial user for testing purposes. This user is configured as administrator of the newly created cluster.
81
82 Assuming you didn't change these values in the @provision.sh@ script, the initial credentials are:
83
84 * User: 'admin'
85 * Password: 'password'
86 * Email: 'admin@arva2.arv.local'