Polish up the README
a lot
This commit is contained in:
parent
ddafeeaaef
commit
ddb1c7decc
20
README.md
20
README.md
@ -1,13 +1,21 @@
|
|||||||
# Salt's Ansible Scripts
|
# Salt's Ansible Scripts
|
||||||
|
|
||||||
A collection of Ansible scripts to manage my desktops and my EC2 environment.
|
A collection of Ansible scripts to manage all of my machines.
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
To deploy a new desktop, try this one-liner:
|
To quickly get a machine up and running, add it to the inventory, role it out, and `./provision.yml` it. The playbook assures a sane running environment and then sets up ansible-pull on a timer that immediately triggers. Leave it be, come back 10 minutes later and polish it up as required.
|
||||||
|
|
||||||
```
|
## Overview
|
||||||
command -v git || sudo apt install -y git; git clone https://git.9iron.club/salt/ansible && cd ansible && ./localhost-deploy.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
Otherwise just run `site.yml`
|
The main playbook, `site.yml`, can be separated into more or less two parts:
|
||||||
|
|
||||||
|
* The home machine half, tied together via Zerotier
|
||||||
|
|
||||||
|
* The 9iron half, with public IPs and resolvable names
|
||||||
|
|
||||||
|
See `inventory/hosts.yml` for details on what machines have what roles and what configuration. I try my best to make self-explaning configuration, so everything should mostly make sense on a first read. If you have any questions, hit me up.
|
||||||
|
|
||||||
|
## Your Roles are Trash
|
||||||
|
|
||||||
|
I know. Please file an issue.
|
||||||
|
Loading…
Reference in New Issue
Block a user