From 7710d6b09753d95a2a7b5675a39e56545f710780 Mon Sep 17 00:00:00 2001 From: michael Date: Wed, 2 Nov 2022 01:09:00 +1300 Subject: [PATCH] improve main readme --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c849493..ef7b6bd 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,11 @@ Opnsense provides firewall, routing (including BGP peering to calico nodes), DNS What you'll also need: -Clone the git repo -Create a vault_password file (chmod 600) under the ansible directory. .gitignore should ensure this doesn't get commited to source control. -Create an ansible vault in your inventory directory tree to hold sensitive variables such as 'ansible_become_pass'. Again .gitignore should ensure this vault file remains only on your workstation. +- Clone the git repo. +- Create a vault_password file (chmod 600) under the ansible directory. +- Ensure .gitignore is correctly setup so that vault_password doesn't get commited to source control. +- Create an ansible vault in your inventory directory tree to hold sensitive variables such as 'ansible_become_pass'. Again, .gitignore should ensure this vault file remains only on your workstation. Check the defaults files for roles carefully. Variables are a scattered mess right now and need to be properly amalgamated. -Ansible roles were written to work on an Arch linux workstation, some tasks are intended to install packages to localhost (such as kubectl) and use pacman modules to do so. - -If you encounter problems with these change those tasks to use your relvant package manager module, eg apt or yum. +Ansible roles were written to work on an Arch linux workstation, some tasks are intended to install packages to localhost (such as kubectl) and use pacman modules to do so. If you encounter problems with these steps, change those tasks to use your relevant package manager module, eg apt or yum.