Another big round of refactoring and cleaning...

This commit is contained in:
2025-07-11 17:55:26 +02:00
parent aa61bf2a44
commit 168c5c0da6
323 changed files with 761 additions and 811 deletions

View File

@@ -0,0 +1,37 @@
# Certbot Reaper
## Description
This Ansible role automates the detection, revocation and deletion of unused Let's Encrypt certificates. It leverages the [`certreap`](https://github.com/kevinveenbirkenbach/certreap) tool to identify certificates no longer referenced by any active NGINX configuration and removes them automatically.
## Overview
- Installs the `certreap` cleanup tool using the `pkgmgr-install` role
- Deploys and configures a `sys-cln-certs.cymais.service` systemd unit
- (Optionally) Sets up a recurring cleanup via a systemd timer using the `sys-timer` role
- Integrates with `sys-alm-compose` to send failure notifications
- Ensures idempotent execution with a `run_once_cleanup_certs` flag
## Features
- **Certificate Cleanup Tool Installation**
Uses `pkgmgr-install` to install the `certreap` binary.
- **Systemd Service Configuration**
Deploys `sys-cln-certs.cymais.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_cleanup_certs` fact.
- **Failure Notification**
Triggers `sys-alm-compose.cymais@sys-cln-certs.cymais.service` on failure.
## Further Resources
- [certreap on GitHub](https://github.com/kevinveenbirkenbach/certreap)
- [Ansible community.general.pacman module](https://docs.ansible.com/ansible/latest/collections/community/general/pacman_module.html)
- [CyMaIS NonCommercial License (CNCL)](https://s.veen.world/cncl)
- [systemd.unit(5) manual](https://www.freedesktop.org/software/systemd/man/systemd.unit.html)

View File

@@ -0,0 +1,6 @@
- name: "Reload and restart sys-cln-certs.cymais.service"
systemd:
name: sys-cln-certs.cymais.service
enabled: yes
daemon_reload: yes
state: restarted

View File

@@ -0,0 +1,28 @@
---
galaxy_info:
author: "Kevin Veen-Birkenbach"
description: "Automates the revocation and deletion of unused Let's Encrypt certificates"
license: "CyMaIS NonCommercial License (CNCL)"
license_url: "https://s.veen.world/cncl"
company: |
Kevin Veen-Birkenbach
Consulting & Coaching Solutions
https://www.veen.world
min_ansible_version: "2.9"
platforms:
- name: Archlinux
versions:
- rolling
galaxy_tags:
- certbot
- ssl
- cleanup
- automation
- systemd
repository: "https://github.com/kevinveenbirkenbach/certreap"
issue_tracker_url: "https://github.com/kevinveenbirkenbach/certreap/issues"
documentation: "https://github.com/kevinveenbirkenbach/certreap#readme"
dependencies:
- sys-alm-compose
- sys-rst-daemon

View File

@@ -0,0 +1,30 @@
- name: "pkgmgr install"
include_role:
name: pkgmgr-install
vars:
package_name: certreap
when: run_once_cleanup_certs is not defined
- name: configure sys-cln-certs.cymais.service
template:
src: sys-cln-certs.service.j2
dest: /etc/systemd/system/sys-cln-certs.cymais.service
notify: Reload and restart sys-cln-certs.cymais.service
when: run_once_cleanup_certs is not defined
- name: "set 'service_name' to '{{ role_name }}'"
set_fact:
service_name: "{{ role_name }}"
when: run_once_cleanup_certs is not defined
- name: "include role for sys-timer for {{service_name}}"
include_role:
name: sys-timer
vars:
on_calendar: "{{ on_calendar_cleanup_certs }}"
when: run_once_cleanup_certs is not defined
- name: run the run_once_cleanup_certs tasks once
set_fact:
run_once_cleanup_certs: true
when: run_once_cleanup_certs is not defined

View File

@@ -0,0 +1,7 @@
[Unit]
Description=Detect, revoke, and delete unused Let's Encrypt certificates based on active NGINX configuration files.
OnFailure=sys-alm-compose.cymais@%n.service
[Service]
Type=oneshot
ExecStart=/bin/sh -c 'certreap --force'