Sys-ctl-cln-docker Role

Description: Systemd-driven cleanup service pruning anonymous Docker volumes plus images, containers, networks, and build cache

Variables

  • author: Kevin Veen-Birkenbach

  • description: Systemd-driven cleanup service pruning anonymous Docker volumes plus images, containers, networks, and build cache

  • license: Infinito.Nexus Community License (Non-Commercial)

  • company: Kevin Veen-Birkenbach https://www.veen.world

  • min_ansible_version: 2.9

  • platforms: [{‘name’: ‘ArchLinux’, ‘versions’: [‘all’]}, {‘name’: ‘Debian’, ‘versions’: [‘all’]}, {‘name’: ‘EL’, ‘versions’: [‘all’]}, {‘name’: ‘Fedora’, ‘versions’: [‘all’]}, {‘name’: ‘Ubuntu’, ‘versions’: [‘all’]}]

  • galaxy_tags: [‘docker’, ‘cleanup’, ‘prune’, ‘automation’, ‘maintenance’, ‘system’]

  • issue_tracker_url: https://s.infinito.nexus/issues

README

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.

    • container system prune -a -f to remove unused Docker resources.

  • Allows forced execution during maintenance runs (MODE_CLEANUP).

Cosmos

The diagram places Cleanup Docker Resources in the Infinito.Nexus cosmos: the components it deploys (capabilities), the central services it consumes (dependencies), and its outward reach (federation and bridged external networks).

flowchart LR
    subgraph role [sys-ctl-cln-docker 💻]
        svc_docker["docker"]
    end

Solid 1:1 edges are fixed relationships; dashed 0..1 edges are conditional (enabled only in matching deployments); red 0..0 edges are turned off in this role. Node markers show the role’s deploy modes (💻 host, 🐳 compose, 🐝 swarm); ❌ marks a service that is explicitly turned off, and ⚙️ an Ansible role dependency declared in meta/main.yml.

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 container 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 container system prune -a -f if Docker is installed.

  4. Stops execution immediately on errors (set -e behavior).

Credits

Implemented by Kevin Veen-Birkenbach. Part of the Infinito.Nexus Project and maintained by Kevin Veen-Birkenbach. Licensed under the Infinito.Nexus Community License (Non-Commercial).