ansible-collection/README.md

Ansible Collection auengun.homelab

A collection of Ansible roles to manage the various tasks in my homelab.

Collection Installation

Python/Poetry Dependencies

TODO: Document these better in version control with renovate.

If using Poetry, this is an example pyproject.toml snippet to install the required Python dependencies.

[tool.poetry.dependencies]
python = "^3.10"
ansible = "^9.2"
ansible-core = "^2.16"
jmespath = "^1.0.1"
passlib = "^1.7.4"

Ansible Galaxy - requirements.yml

Add the following snippet to Ansible Galaxy's requirements.yml file.

collections:
- name: ssh://git@git.auengun.net/homelab/ansible-collection.git
  type: git
  # Note: it's better to pin to a commit than main.
  version: main

Then install using ansible-galaxy.

ansible-galaxy collection install -r requirements.yml

Roles

auengun.homelab.caddy

A systemd service wrapping a custom caddy binary enabling some rate limiting and other features for my common services.

Read the README.md for usage and configuration details.

auengun.homelab.common

A set of shifting common tasks for bootstrapping and setting up the many physical and virtual machines in my homelab.

Read the README.md for usage and configuration details.

auengun.homelab.dcaass

Wraps a docker-compose.yml with a systemd service and easy user overrides of the .yml config.

Read the README.md for usage and configuration details.

auengun.homelab.cron_healthcheck_script

Quickly wrap a basic shell script with a crontab schedule and Healthchecks.io alert.

Read the README.md for usage and configuration details.