Merge branch '17346-keep-balance-empty-block'
[arvados.git] / doc / install / salt.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Salt prerequisites
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 # "Introduction":#introduction
13 # "Install Saltstack":#saltstack
14 # "Choose an Arvados installation configuration":#installconfiguration
15
16 h2(#introduction). Introduction
17
18 To ease the installation of the various Arvados components, we have developed a "Saltstack":https://www.saltstack.com/ 's "arvados-formula":https://github.com/arvados/arvados-formula.git which can help you get an Arvados cluster up and running.
19
20 Saltstack is a Python-based, open-source software for event-driven IT automation, remote task execution, and configuration management. It can be used in a master/minion setup or master-less.
21
22 This is a package-based installation method. The Salt scripts to install and configure Arvados using this formula are available at the "tools/salt-install":https://github.com/arvados/arvados/tree/master/tools/salt-install directory in the Arvados git repository.
23
24 h2(#saltstack). Install Saltstack
25
26 If you already have a Saltstack environment or you plan to use the @provision.sh@ script we provide, you can skip this section.
27
28 The simplest way to get Salt up and running on a node is to use the bootstrap script they provide:
29
30 <notextile>
31 <pre><code>curl -L https://bootstrap.saltstack.com -o /tmp/bootstrap_salt.sh
32 sudo sh /tmp/bootstrap_salt.sh -XUdfP -x python3
33 </code></pre>
34 </notextile>
35
36 For more information check "Saltstack's documentation":https://docs.saltstack.com/en/latest/topics/installation/index.html
37
38 h2(#installconfiguration). Choose an Arvados installation configuration
39
40 The salt formula can be used in a few different ways. Choose one of these three options to install Arvados:
41
42 * "Arvados on a single host":salt-single-host.html
43 * "Arvados across multiple hosts":salt-multi-host.html
44 * "Use Vagrant to install Arvados in a virtual machine":salt-vagrant.html