ansible-collections/hcp-ansible
ansible-collections/hcp-ansible
4
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

docs: add documentation on running preflight and bootstrap playbooks
All checks were successful
development / Check commit compliance (push) Successful in 6s
Details

Browse Source
This commit is contained in:
Bertrand Lanson 2024-07-03 22:37:00 +02:00
parent 042e3593ca
commit 48a7724759
Signed by: lanson
SSH Key Fingerprint: SHA256:/nqc6HGqld/PS208F6FUOvZlUzTS0rGpNNwR5O2bQBw
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/quick_start.md
View File

@ -60,7 +60,7 @@ source /path/to/venv/bin/activate
pip install -U pip 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 ```bash
pip install 'ansible-core>=2.15' pip install 'ansible-core>=2.15'
@ -114,7 +114,7 @@ You should now have some roles inside `./roles/`.
## Generate Credentials ## 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. 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] > [!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). > 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.