mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-10-31 10:19:09 +00:00
Kevin Veen-Birkenbach
3a839cfe37
This commit restructures systemctl service definitions and category mappings. Motivation: Alarm-related bugs revealed inconsistencies in service and role handling. Preparation step: lays the groundwork for fixing the alarm issues by aligning categories, roles, and service templates.
32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
# Docker Volumes Health Check
|
|
|
|
## Description
|
|
|
|
This role detects unused **anonymous Docker volumes** that are not bound to any running container.
|
|
It can optionally exclude specific volumes from the check using a configurable whitelist.
|
|
|
|
## Overview
|
|
|
|
The role installs a script and a `systemd` service with a timer to periodically scan for leftover anonymous volumes.
|
|
This helps prevent wasted disk space and leftover resources from old deployments.
|
|
|
|
## Purpose
|
|
|
|
The main purpose of this role is to keep Docker environments clean by identifying and reporting orphaned anonymous volumes.
|
|
It supports a whitelist mechanism to avoid alerting on known or intentional volumes.
|
|
|
|
## Features
|
|
|
|
- **Anonymous Volume Detection:** Identifies volumes with 64-character IDs not attached to any container.
|
|
- **Whitelist Support:** Skips volumes listed in `DOCKER_WHITELISTET_ANON_VOLUMES`.
|
|
- **Bootstrap Volume Exclusion:** Ignores known bootstrap volumes (e.g., `/var/www/bootstrap`).
|
|
- **Systemd Integration:** Installs a one-shot service and timer to automate checks.
|
|
- **Alerting Support:** Works with the [`sys-ctl-alm-compose`](../sys-ctl-alm-compose/README.md) role for failure notifications.
|
|
|
|
## Further Resources
|
|
|
|
- [Docker Volumes Documentation](https://docs.docker.com/storage/volumes/)
|
|
- [Systemd Timers Documentation](https://www.freedesktop.org/software/systemd/man/systemd.timer.html)
|
|
- [ChatGPT Create Conversation](https://chat.openai.com/share/1fa829f1-f001-4111-b1d4-1b2e3d583da2).
|
|
|