Add some writeup to readme

This commit is contained in:
Jake Howard 2019-12-08 19:33:13 +00:00
parent 7713820e51
commit db941391ca
Signed by: jake
GPG key ID: 57AFB45680EDD477

View file

@ -2,3 +2,24 @@
![Ansible Status](https://github.com/realorangeone/infrastructure/workflows/Ansible/badge.svg) ![Ansible Status](https://github.com/realorangeone/infrastructure/workflows/Ansible/badge.svg)
![Generic Linting](https://github.com/realorangeone/infrastructure/workflows/Lint/badge.svg) ![Generic Linting](https://github.com/realorangeone/infrastructure/workflows/Lint/badge.svg)
## Requirements
- Python 3
- Locally configured SSH config (ideally deployed through [dotfiles](https://github.com/realorangeone/dotfiles))
## Installation
`./scripts/setup.sh`
### Private Settings
The ansible vault password needs setting in `ansible/.vault_pass`.
## Deploying
`./scripts/deploy.sh`
Alternatively, each component can be deployed separately:
- `./scripts/ansible.sh`