docs(salt): some minor fixes in the Salt-based installation documentation.
[arvados.git] / doc / install / salt-vagrant.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Arvados in a VM with Vagrant
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 # "Vagrant":#vagrant
13 # "DNS configuration":#final_steps
14 # "Initial user and login":#initial_user
15
16 h2(#vagrant). Vagrant
17
18 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.
19
20 A @Vagrantfile@ is provided to install Arvados in a virtual machine on your computer using "Vagrant":https://www.vagrantup.com/.
21
22 To get it running, install Vagrant in your computer, edit the variables at the top of the @provision.sh@ script as needed, and run
23
24 <notextile>
25 <pre><code>vagrant up
26 </code></pre>
27 </notextile>
28
29 If you want to reconfigure the running box, you can just:
30
31 1. edit the pillars to suit your needs
32 2. run
33
34 <notextile>
35 <pre><code>vagrant reload --provision
36 </code></pre>
37 </notextile>
38
39 h2(#final_steps). DNS configuration
40
41 After the setup is done, you need to set up your DNS to be able to access the cluster.
42
43 The simplest way to do this is to edit your @/etc/hosts@ file (as root):
44
45 <notextile>
46 <pre><code>export CLUSTER="arva2"
47 export DOMAIN="arv.local"
48 export HOST_IP="127.0.0.2"    # This is valid either if installing in your computer directly
49                               # or in a Vagrant VM. If you're installing it on a remote host
50                               # just change the IP to match that of the host.
51 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
52 </code></pre>
53 </notextile>
54
55 h2(#initial_user). Initial user and login
56
57 At this point you should be able to log into the Arvados cluster.
58
59 If you didn't change the defaults, the initial URL will be:
60
61 * https://workbench.arva2.arv.local:8443
62
63 or, in general, the url format will be:
64
65 * https://workbench.@<cluster>.<domain>:8443@
66
67 By default, the provision script creates an initial user for testing purposes. This user is configured as administrator of the newly created cluster.
68
69 Assuming you didn't change the defaults, the initial credentials are:
70
71 * User: 'admin'
72 * Password: 'password'
73 * Email: 'admin@arva2.arv.local'