Certbot Reaper

Description

Overview

  • Installs the certreap cleanup tool using the pkgmgr-install role

  • Deploys and configures a systemd unit

  • (Optionally) Sets up a recurring cleanup via a systemd timer using the sys-timer role

  • Integrates with sys-ctl-alm-compose to send failure notifications

  • Ensures idempotent execution with a run_once_sys_ctl_cln_certs flag

Cosmos

The diagram places Certbot Reaper 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-certs 💻]
        svc_certs["certs"]
    end
    subgraph dependents [Dependents]
        dpt_sys_ctl_mtn_cert_renew["sys-ctl-mtn-cert-renew 💻 ⚙️"]
    end
    svc_certs -- "1:1" --> dpt_sys_ctl_mtn_cert_renew

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.

Features

  • Certificate Cleanup Tool Installation
    Uses pkgmgr-install to install the certreap binary.

  • Systemd Service Configuration
    Deploys service and reloads/restarts it on changes.

  • Systemd Timer Scheduling
    Optionally wires in a timer via the sys-timer role, controlled by the on_calendar_cleanup_certs variable.

  • Smart Execution Logic
    Prevents multiple runs in one play by setting a run_once_sys_ctl_cln_certs fact.

  • Failure Notification
    Triggers service on failure.

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