From 646f81e50b218262496b858ea240bd8746eb2d88 Mon Sep 17 00:00:00 2001 From: Bertrand Lanson Date: Sat, 17 Aug 2024 14:06:47 +0200 Subject: [PATCH] docs: update documentation --- docs/general.md | 8 ++++---- docs/quick_start.md | 10 ++++++++++ docs/tls_guide.md | 5 +++++ 3 files changed, 19 insertions(+), 4 deletions(-) diff --git a/docs/general.md b/docs/general.md index 3af4378..11459ae 100644 --- a/docs/general.md +++ b/docs/general.md @@ -6,7 +6,7 @@ Hashistack Ansible uses a configuration directory to store all the configuration files and other artifacts. -This directory is defined with the variable `configuration_directory`. By default, it will look at `{{ lookup('env', 'PWD') }}/etc/hashistack`, which equals `$(pwd)/etc/hashistack`. +This directory is defined with the variable `hashistack_configuration_directory`. By default, it will look at `{{ lookup('env', 'PWD') }}/etc/hashistack`, which equals `$(pwd)/etc/hashistack`. Under this directory, you are expected to place the `globals.yml` file, with your configuration. @@ -18,9 +18,9 @@ Additionally, subdirectories can be used to tailor the configuration further. Each group within the `inventory` will look at a directory named after itself: -- nomad_servers group will look for `{{ configuration_directory }}/nomad_servers` -- vault_servers group will look for `{{ configuration_directory }}/vault_servers` -- consul_servers group will look for `{{ configuration_directory }}/consul_servers` +- nomad_servers group will look for `{{ hashistack_configuration_directory }}/nomad_servers` +- vault_servers group will look for `{{ hashistack_configuration_directory }}/vault_servers` +- consul_servers group will look for `{{ hashistack_configuration_directory }}/consul_servers` Within each of these directories, you can place an additional `globals.yml file`, that will superseed the file at the root of the configuration directory. diff --git a/docs/quick_start.md b/docs/quick_start.md index a822545..c06db76 100644 --- a/docs/quick_start.md +++ b/docs/quick_start.md @@ -112,6 +112,16 @@ This will install roles that are not packaged with the collection, but are still You should now have some roles inside `./roles/`. +9. Copy `inventory` file and `globals.yml `file locally + +```bash +cp collections/ansible_collections/ednz_cloud/hashistack/playbooks/inventory/multinode.ini inventory/ +``` + +```bash +cp collections/ansible_collections/ednz_cloud/hashistack/playbooks/group_vars/all/globals.yml etc/hashistack/globals.yml +``` + ## Generate Credentials Before deploying your infrastructure with Hashistack-Ansible, you need to generate credentials that will be used to bootstrap the various clusters. diff --git a/docs/tls_guide.md b/docs/tls_guide.md index f26e45d..2eb4699 100644 --- a/docs/tls_guide.md +++ b/docs/tls_guide.md @@ -1 +1,6 @@ # TLS Guide + + +create certificate/ca directory + +`ansible-playbook -i inventory/multinode.ini ednz_cloud.hashistack.generate_certs.yml`