Merge branch '18631-shell-login-sync'
[arvados-formula.git] / test / salt / states / examples / single_host / README.rst
1 Helper states for all-in-one setup
2 ==================================
3
4 ..
5    # Copyright (C) The Arvados Authors. All rights reserved.
6    #
7    # SPDX-License-Identifier: Apache-2.0
8
9 These states are helpful for setting up an all-in-one Arvados host.
10
11 * `host_entries.sls`: adds a bunch of host entries in the `/etc/hosts` file of
12   the host instance, so all Arvados' components can find each other correctly,
13   using meaningful names.
14
15 * `snakeoil_certs.sls`: Arvados uses SSL/TLS for communications, so you'll need
16   certificates for the different hosts. If you can't provide valid certificates
17   issued by a recognized CA, this state will create a SnakeOil CA and issue
18   certificates signed by it.
19
20   The certs can't be self-signed because some of the libraries that Arvados
21   uses require certs issued by a CA. For this reason, if you use this state,
22   you'll need to copy the created CA cert to your certificates' directory.