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 # "Test the installed cluster running a simple workflow":#test_install
  16
  17 h2(#vagrant). Vagrant
  18
  19 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.
  20
  21 A @Vagrantfile@ is provided to install Arvados in a virtual machine on your computer using "Vagrant":https://www.vagrantup.com/.
  22
  23 To get it running, install Vagrant in your computer, edit the variables at the top of the @provision.sh@ script as needed, and run
  24
  25 <notextile>
  26 <pre><code>vagrant up
  27 </code></pre>
  28 </notextile>
  29
  30 If you want to reconfigure the running box, you can just:
  31
  32 1. edit the pillars to suit your needs
  33 2. run
  34
  35 <notextile>
  36 <pre><code>vagrant reload --provision
  37 </code></pre>
  38 </notextile>
  39
  40 h2(#final_steps). DNS configuration
  41
  42 After the setup is done, you need to set up your DNS to be able to access the cluster.
  43
  44 The simplest way to do this is to edit your @/etc/hosts@ file (as root):
  45
  46 <notextile>
  47 <pre><code>export CLUSTER="arva2"
  48 export DOMAIN="arv.local"
  49 export HOST_IP="127.0.0.2"    # This is valid either if installing in your computer directly
  50                               # or in a Vagrant VM. If you're installing it on a remote host
  51                               # just change the IP to match that of the host.
  52 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
  53 </code></pre>
  54 </notextile>
  55
  56 h2(#initial_user). Initial user and login
  57
  58 At this point you should be able to log into the Arvados cluster.
  59
  60 If you didn't change the defaults, the initial URL will be:
  61
  62 * https://workbench.arva2.arv.local:8443
  63
  64 or, in general, the url format will be:
  65
  66 * https://workbench.@<cluster>.<domain>:8443@
  67
  68 By default, the provision script creates an initial user for testing purposes. This user is configured as administrator of the newly created cluster.
  69
  70 Assuming you didn't change the defaults, the initial credentials are:
  71
  72 * User: 'admin'
  73 * Password: 'password'
  74 * Email: 'admin@arva2.arv.local'
  75
  76 h2(#test_install). Test the installed cluster running a simple workflow
  77
  78 As documented in the <a href="{{ site.baseurl }}/install/salt-single-host.html">Single Host installation</a> page, You can run a test workflow to verify the installation finished correctly. To do so, you can follow these steps:
  79
  80 <notextile>
  81 <pre><code>vagrant ssh</code></pre>
  82 </notextile>
  83
  84 and once in the instance:
  85
  86 <notextile>
  87 <pre><code>cd /tmp/cluster_tests
  88 ./run-test.sh
  89 </code></pre>
  90 </notextile>