18248: update comment addressing review suggestions
[arvados.git] / tools / salt-install / README.md
1 [comment]: # (Copyright © The Arvados Authors. All rights reserved.)
2 [comment]: # ()
3 [comment]: # (SPDX-License-Identifier: CC-BY-SA-3.0)
4
5 # Arvados install with Saltstack
6
7 ##### About
8
9 This directory holds a small script to help you get Arvados up and running, using the
10 [Saltstack arvados-formula](https://git.arvados.org/arvados-formula.git)
11 in master-less mode.
12
13 There are a few preset examples that you can use:
14
15 * `single_host`: Install all the Arvados components in a single host. Suitable for testing
16   or demo-ing, but not recommended for production use.
17 * `multi_host/aws`: Let's you install different Arvados components in different hosts on AWS.
18   
19 The fastest way to get it running is to copy the `local.params.example` file to `local.params`,
20 edit and modify the file to suit your needs, copy this file along with the `provision.sh` script
21 into the host where you want to install Arvados and run the `provision.sh` script as root.
22
23 There's an example `Vagrantfile` also, to install Arvados in a vagrant box if you want
24 to try it locally.
25
26 For more information, please read https://doc.arvados.org/main/install/salt-single-host.html