Polish README

This commit is contained in:
Salt 2022-04-18 11:30:34 -05:00
parent 77878b3a66
commit 49b6335490

View File

@ -1,6 +1,6 @@
# Salt's Ansible Repository
# desu.ltd Ansible Management Repository
Useful for management across all of 9iron, thefuck, and desu.
Contains core system configuration for all of desu.ltd and related environments
## Initialization
@ -9,7 +9,7 @@ Useful for management across all of 9iron, thefuck, and desu.
For quick bootstrapping of tools and libraries used in this repo, see [rehashedsalt/ansible-env](https://gitlab.com/rehashedsalt/docker-ansible-env). I use that exact image for CI/CD.
## Deployment
## Machine Setup
### Linux Machines
@ -25,24 +25,14 @@ Each Linux machine will require the following to be fulfilled for Ansible to acc
To automate these host-local steps, use the script file `contrib/bootstrap.sh`.
### Windows Machines
### Other Machines
lol don't
Unsupported at this time, though things that accept SSH might Just Work.
### All Machines
## Machine Deployment
Adding a new server will require these:
* The server is accessible from the Ansible host;
* The server has been added to NetBox OR in `inventory-hard`
* DNS records for the machine are set; and
From there, running the playbook `site.yml` should get the machine up to snuff.
Deploying a new server will require that it be added to NetBox and that it is accessible from the Ansible host. From there, running the main playbook `site.yml` will get the machine up to snuff.
## Zerotier
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.
A lot of my home network is connected via Zerotier. Initial deployment can be done locally through a bastion machine or similar, but subsequent deploys should run over Zerotier. Once configuration is available, you should log into the machine and modify Netbox to document its Zerotier IP in Netbox, setting it to be the primary IP of the device. The interface name should be `zt0`.