From 48a7724759e4bbc9027f9b5d6fac4b5b9493a05b Mon Sep 17 00:00:00 2001 From: Bertrand Lanson Date: Wed, 3 Jul 2024 22:37:00 +0200 Subject: [PATCH] docs: add documentation on running preflight and bootstrap playbooks --- docs/quick_start.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/quick_start.md b/docs/quick_start.md index 8282f3f..a822545 100644 --- a/docs/quick_start.md +++ b/docs/quick_start.md @@ -60,7 +60,7 @@ source /path/to/venv/bin/activate pip install -U pip ``` -4. Install [Ansible](http://www.ansible.com/). Hashistack Ansible requires at least Ansible **7**(or ansible-core **2.15**) +4. Install [Ansible](http://www.ansible.com/). Hashistack-Ansible requires at least Ansible **7**(or ansible-core **2.15**) ```bash pip install 'ansible-core>=2.15' @@ -114,7 +114,7 @@ You should now have some roles inside `./roles/`. ## Generate Credentials -Before deploying your infrastructure with hashistack-ansible, you need to generate credentials that will be used to bootstrap the various clusters. +Before deploying your infrastructure with Hashistack-Ansible, you need to generate credentials that will be used to bootstrap the various clusters. This can be done by running the `generate_credentials.yml` playbook. @@ -131,3 +131,14 @@ This does not generate vault credentials, as it is not possible to generate thos > [!WARNING] > It is HIGHLY recommended to encrypt these two files before enventually commiting them to source control. You can do so using tools like [ansible-vault](https://docs.ansible.com/ansible/latest/cli/ansible-vault.html) or [sops](https://github.com/getsops/sops). + +## Running preflight checks and bootstrap playbooks + +Before running the main deployment playbook, you might want to run the `bootstrap` and `preflight` playbooks, which do a number of checks to ensure all hosts are setup correctly for deployment. + +```bash +ansible-playbook -i inventory/inventory.ini ednz_cloud.hashistack.bootstrap.yml +ansible-playbook -i inventory/inventory.ini ednz_cloud.hashistack.preflight.yml +``` + +These playbooks will run a number of checks, and installations, in order to ensure the target hosts, as well as your deployment environment are correctly setup in order to install all the components.