Add a basic README for the ansible folder

1 files changed, 17 insertions, 0 deletions

diff --git a/ansible/README.md b/ansible/README.md
new file mode 100644
index 0000000..b823e56
--- /dev/null
+++ b/ansible/README.md
@@ -0,0 +1,17 @@
+# Ansible
+
+This folder contains Ansible roles which are used to configure out bare metal servers.
+
+## Local Environment Setup
+
+To setup a local environment using VMs for testing, [Read here](./local_testing/README.md)
+
+1. Create a virtual environment: `python -m venv venv`
+1. Activate the virtual environment
+   - Windows: `.\venv\Scripts\activate`
+    - Note: [Ansible cannot run on Windows hosts natively](https://docs.ansible.com/ansible/latest/user_guide/windows_faq.html#can-ansible-run-on-windows)
+   - Unix: `source venv/bin/activate`
+1. Update pip and builder deps: `python -m pip install --upgrade pip wheel setuptools`
+1. Install project dependencies: `python -m pip install -r requirements.txt`
+1. Install the pre-commit hook: `pre-commit install`
+1. Create a `vault_passwords` file and write the vault password to it