Files
computer-playbook/roles/sys-ctl-cln-docker
Kevin Veen-Birkenbach e09f561f0b Refactor run-once orchestration and bootstrap Mailu/Mastodon in a single deploy
- Replace legacy utils/run_once.yml with the new helpers utils/once_flag.yml and utils/once_finalize.yml
- Introduce utils/compose_up.yml to ensure docker-compose stacks are up and to flush handlers safely without coupling to run-once flags
- Migrate all affected roles (desk-*, dev-*, sys-ctl-*, sys-svc-*, web-app-*, web-svc-*, util-*) to the new run-once helpers
- Rework sys-svc-msmtp to auto-load Mailu once per deploy, check reachability, and reuse the running stack instead of requiring multiple playbook passes
- Adjust web-app-mailu to integrate cert deployment, handler flushing, and run-once handling so Mailu is fully initialized in a single deploy
- Improve Matomo, CDN, logout and CSP/health-check related roles to cooperate with the new compose_up / once_* pattern
- Simplify alarm/backup/timer/service orchestration (sys-ctl-alm-*, sys-bkp-provider, sys-timer-cln-bkps, etc.) by moving run-once logic into dedicated 01_core.yml files
- Update integration tests so utils/once_flag.yml and utils/once_finalize.yml are recognised as valid run-once providers, keeping the global run_once_* guarantees consistent
- Align frontend injection and service dependencies so Mastodon- and Mailu-related services can be brought up coherently within a single deployment cycle rather than several iterations
2025-12-01 13:30:50 +01:00
..

Cleanup Docker Resources

Description

This role performs a complete cleanup of Docker resources by invoking a systemd-managed script. It removes unused Docker images, stopped containers, networks, build cache, and anonymous volumes. The cleanup is fully automated and can run on a schedule or be triggered manually.

Overview

Optimized for maintaining a clean and efficient Docker environment, this role:

  • Loads and triggers the anonymous volume cleanup role.

  • Installs a systemd service and timer for Docker pruning.

  • Deploys a cleanup script that invokes:

    • The anonymous volume cleanup service.
    • docker system prune -a -f to remove unused Docker resources.
  • Allows forced execution during maintenance runs (MODE_CLEANUP).

Purpose

The primary purpose of this role is to prevent storage bloat caused by unused Docker images, volumes, and build artifacts. Regular pruning ensures:

  • Reduced disk usage
  • Improved system performance
  • Faster CI/CD and container deployments
  • More predictable Docker engine behavior

Features

  • Anonymous Volume Cleanup: Integrates with sys-ctl-cln-anon-volumes to remove stale volumes.
  • Full Docker Prune: Executes docker system prune -a -f to reclaim space.
  • Systemd Integration: Registers a systemd unit and timer for automated cleanup.
  • Scheduled Execution: Runs daily (or as configured) based on SYS_SCHEDULE_CLEANUP_DOCKER.
  • Force Execution Mode: When MODE_CLEANUP=true, cleanup is executed immediately.
  • Safe Execution: Includes validation for missing services and Docker availability.

Script Behavior

The cleanup script:

  1. Checks whether the anonymous volume cleanup service is defined and available.
  2. Starts the service if present.
  3. Runs docker system prune -a -f if Docker is installed.
  4. Stops execution immediately on errors (set -e behavior).