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