Sys-ctl-cln-bkps Role

Description: Scheduled systemd maintenance service for pruning outdated backup versions when disk usage exceeds a threshold

Variables

  • author: Kevin Veen-Birkenbach

  • description: Scheduled systemd maintenance service for pruning outdated backup versions when disk usage exceeds a threshold

  • 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: [‘backup’, ‘cleanup’, ‘disk’, ‘automation’]

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

README

Cleanup Backups Service

Description

This role automates the cleanup of old backups by executing a Python script that deletes outdated backup versions based on disk usage thresholds. It ensures that backup storage does not exceed a defined usage percentage.

Overview

Optimized for effective disk space management, this role:

  • Installs required packages (e.g. lsof and psutil) using pacman.

  • Creates a directory for storing cleanup scripts.

  • Deploys a Python script that deletes old backup directories when disk usage is too high.

  • Configures a systemd service to run the cleanup script, with notifications via sys-ctl-alm-compose.

Cosmos

The diagram places Cleanup Backups Service 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-bkps 💻]
        svc_bkps["bkps"]
    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 maintain optimal backup storage by automatically removing outdated backup versions when disk usage exceeds a specified threshold.

Features

  • Automated Cleanup: Executes a Python script to delete old backups.

  • Threshold-Based Deletion: Removes backups based on disk usage percentage.

  • Systemd Integration: Configures a systemd service to run cleanup tasks.

  • Dependency Integration: Works in conjunction with related roles for comprehensive backup management.

Other Resources

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).