Polish up readme

This commit is contained in:
Salt 2021-09-18 16:44:56 -05:00
parent cf92fde0d4
commit 38af921c96

View File

@ -1,16 +1,10 @@
# Salt's Ansible Repository
Useful for management across all of 9iron, thefuck, and desu.
## TODO
* Figure out a good monitoring solution that doesn't suck ass
* Port over configs for Nextcloud on web1.9iron.club
## Initialization
Clone the repo, `cd` in. Done.
* Clone
* `ansible-galaxy install -r requirements.yml`
## Deployment
@ -24,7 +18,7 @@ Adding a new server will require the following be fulfilled:
* Has passwordless sudo capabilities as root
* The server is added to `inventory/hosts.yml` in an appropriate place;
* The server has been added to NetBox OR in `inventory-hard`
* DNS records for the machine are set; and
@ -37,23 +31,3 @@ From there, running the playbook `site.yml` should get the machine up to snuff.
A lot of my home-network side of things is connected together via ZeroTier; initial deployment/repairs may require specifying an `ansible_host` for the inventory item in question to connect to it locally. Subsequent plays will require connectivity to my home ZeroTier network.
Cloud-managed devices require no such workarounds.
## Ad-Hoc Commands
The inventory is configured to allow for ad-hoc commands with very little fuss. For example:
```bash
ansible -m shell -a 'systemctl is-failed ansible-pull.service' all
```
These commands must be run from the root of the repo.
## Ansible Galaxy
Several of the roles in this repository are sourced from Ansible Galaxy. They're mirrored here for both easy compatibility with `ansible-pull` and in case the sources go down. Despite this, they're still managed in `roles/requirements.yml` for ease of management, source tracking, and updating. Any forks or deviations from these sources should be thoroughly documented.
Should you need to reinitialize them, the following command (run from the root of the repo) will initialize all Galaxy assets:
```
ansible-galaxy install -r roles/requirements.yml
```