Add some writeup to readme
This commit is contained in:
parent
7713820e51
commit
db941391ca
1 changed files with 21 additions and 0 deletions
21
README.md
21
README.md
|
@ -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`
|
||||||
|
|
Loading…
Reference in a new issue