mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-05-09 14:55:44 +02:00
Compare commits
3 Commits
9575ee31ff
...
f71c9e4b31
Author | SHA1 | Date | |
---|---|---|---|
f71c9e4b31 | |||
9fb1655111 | |||
7afa368594 |
@ -6,11 +6,12 @@ on_calendar_health_disc_space: "*-*-* 06,12,18,00:00:00"
|
|||||||
on_calendar_health_docker_container: "*-*-* {{ hours_server_awake }}:00:00" # Check once per hour if the docker containers are healthy
|
on_calendar_health_docker_container: "*-*-* {{ hours_server_awake }}:00:00" # Check once per hour if the docker containers are healthy
|
||||||
on_calendar_health_docker_volumes: "*-*-* {{ hours_server_awake }}:15:00" # Check once per hour if the docker volumes are healthy
|
on_calendar_health_docker_volumes: "*-*-* {{ hours_server_awake }}:15:00" # Check once per hour if the docker volumes are healthy
|
||||||
on_calendar_health_nginx: "*-*-* {{ hours_server_awake }}:45:00" # Check once per hour if all webservices are available
|
on_calendar_health_nginx: "*-*-* {{ hours_server_awake }}:45:00" # Check once per hour if all webservices are available
|
||||||
on_calendar_health_msmtp: "*-*-* 00:00:00" # Check once per day SMTP Server
|
on_calendar_health_msmtp: "*-*-* 00:00:00" # Check once per day SMTP Server
|
||||||
|
|
||||||
## Schedule for Cleanup Tasks
|
## Schedule for Cleanup Tasks
|
||||||
on_calendar_cleanup_backups: "*-*-* 00,06,12,18:30:00" # Cleanup backups every 6 hours, MUST be called before disc space cleanup
|
on_calendar_cleanup_backups: "*-*-* 00,06,12,18:30:00" # Cleanup backups every 6 hours, MUST be called before disc space cleanup
|
||||||
on_calendar_cleanup_disc_space: "*-*-* 07,13,19,01:30:00" # Cleanup disc space every 6 hours
|
on_calendar_cleanup_disc_space: "*-*-* 07,13,19,01:30:00" # Cleanup disc space every 6 hours
|
||||||
|
on_calendar_cleanup_certs: "*-*-* 12,00:45:00" # Deletes and revokes unused certs
|
||||||
|
|
||||||
## Schedule for Backup Tasks
|
## Schedule for Backup Tasks
|
||||||
on_calendar_backup_docker_to_local: "*-*-* 03:30:00"
|
on_calendar_backup_docker_to_local: "*-*-* 03:30:00"
|
||||||
|
25
roles/cleanup-certs/README.md
Normal file
25
roles/cleanup-certs/README.md
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
# Certbot Reaper
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
This Ansible role automates the process of detecting, revoking, and deleting unused Let's Encrypt certificates. It leverages the [`certreap`](https://github.com/kevinveenbirkenbach/certreap) tool to identify which certificates are no longer referenced by any active NGINX configuration and removes them accordingly.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Optimized for Archlinux, this role installs the certificate cleanup tool, configures a systemd service, and sets up an optional recurring systemd timer for automatic cleanup. It integrates with dependent roles for timer scheduling and system notifications.
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Certbot Reaper helps you maintain a clean and secure server environment by regularly removing obsolete SSL certificates. This prevents unnecessary renewal attempts, clutter, and potential security risks from stale certificates.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **Certificate Cleanup Tool Installation:** Installs `certreap` using [pkgmgr](https://github.com/kevinveenbirkenbach/package-manager)
|
||||||
|
- **Systemd Service Configuration:** Deploys and manages `cleanup-certs.cymais.service`
|
||||||
|
- **Systemd Timer Scheduling:** Optional timer via the `systemd-timer` role
|
||||||
|
- **Smart Execution Logic:** Ensures idempotent configuration using a `run_once` flag
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This role is licensed under the [CyMaIS NonCommercial License (CNCL)](https://s.veen.world/cncl).
|
||||||
|
Commercial use is not permitted without explicit permission.
|
6
roles/cleanup-certs/handlers/main.yml
Normal file
6
roles/cleanup-certs/handlers/main.yml
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
- name: "Reload and restart cleanup-certs.cymais.service"
|
||||||
|
systemd:
|
||||||
|
name: cleanup-certs.cymais.service
|
||||||
|
enabled: yes
|
||||||
|
daemon_reload: yes
|
||||||
|
state: restarted
|
28
roles/cleanup-certs/meta/main.yml
Normal file
28
roles/cleanup-certs/meta/main.yml
Normal 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:
|
||||||
|
- systemd-timer
|
||||||
|
- systemd-notifier
|
30
roles/cleanup-certs/tasks/main.yml
Normal file
30
roles/cleanup-certs/tasks/main.yml
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
- name: "pkgmgr install"
|
||||||
|
include_role:
|
||||||
|
name: pkgmgr-install
|
||||||
|
vars:
|
||||||
|
package_name: cleanup-certs
|
||||||
|
when: run_once_cleanup_certs is not defined
|
||||||
|
|
||||||
|
- name: configure cleanup-certs.cymais.service
|
||||||
|
template:
|
||||||
|
src: cleanup-certs.service.j2
|
||||||
|
dest: /etc/systemd/system/cleanup-certs.cymais.service
|
||||||
|
notify: Reload and restart cleanup-certs.cymais.service
|
||||||
|
when: run_once_cleanup_certs is not defined
|
||||||
|
|
||||||
|
- name: set service_name to the name of the current role
|
||||||
|
set_fact:
|
||||||
|
service_name: "{{ role_name }}"
|
||||||
|
when: run_once_cleanup_certs is not defined
|
||||||
|
|
||||||
|
- name: "include role for systemd-timer for {{service_name}}"
|
||||||
|
include_role:
|
||||||
|
name: systemd-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
|
7
roles/cleanup-certs/templates/certs.service.j2
Normal file
7
roles/cleanup-certs/templates/certs.service.j2
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Detect, revoke, and delete unused Let's Encrypt certificates based on active NGINX configuration files.
|
||||||
|
OnFailure=systemd-notifier.cymais@%n.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
ExecStartPre=/bin/sh -c '/usr/bin/python certreap --force'
|
@ -5,7 +5,7 @@ services:
|
|||||||
{% include 'roles/docker-central-database/templates/services/' + database_type + '.yml.j2' %}
|
{% include 'roles/docker-central-database/templates/services/' + database_type + '.yml.j2' %}
|
||||||
|
|
||||||
application:
|
application:
|
||||||
image: snipe/snipe-it:{{applications.snipe_it.version}}
|
image: grokability/snipe-it:{{applications.snipe_it.version}}
|
||||||
{% include 'roles/docker-compose/templates/services/base.yml.j2' %}
|
{% include 'roles/docker-compose/templates/services/base.yml.j2' %}
|
||||||
volumes:
|
volumes:
|
||||||
- data:/var/lib/snipeit
|
- data:/var/lib/snipeit
|
||||||
|
@ -30,3 +30,4 @@ dependencies:
|
|||||||
- certbot
|
- certbot
|
||||||
- nginx
|
- nginx
|
||||||
- systemd-notifier
|
- systemd-notifier
|
||||||
|
- cleanup-certs
|
||||||
|
@ -115,8 +115,8 @@ def update_docker(directory):
|
|||||||
need_to_build = True
|
need_to_build = True
|
||||||
|
|
||||||
if need_to_build:
|
if need_to_build:
|
||||||
# @todo Here a pull for openproject should be placed.
|
# This propably just rebuilds the Dockerfile image if there is a change in the other docker compose containers
|
||||||
run_command("docker-compose build")
|
run_command("docker-compose build --pull")
|
||||||
start_docker(directory)
|
start_docker(directory)
|
||||||
else:
|
else:
|
||||||
print("Docker images are up to date. No rebuild necessary.")
|
print("Docker images are up to date. No rebuild necessary.")
|
||||||
@ -174,7 +174,7 @@ def update_nextcloud():
|
|||||||
update_procedure("docker-compose exec -T -u www-data application /var/www/html/occ db:add-missing-columns")
|
update_procedure("docker-compose exec -T -u www-data application /var/www/html/occ db:add-missing-columns")
|
||||||
update_procedure("docker-compose exec -T -u www-data application /var/www/html/occ db:add-missing-indices")
|
update_procedure("docker-compose exec -T -u www-data application /var/www/html/occ db:add-missing-indices")
|
||||||
update_procedure("docker-compose exec -T -u www-data application /var/www/html/occ db:add-missing-primary-keys")
|
update_procedure("docker-compose exec -T -u www-data application /var/www/html/occ db:add-missing-primary-keys")
|
||||||
print("Deacitvate Maintanance Mode")
|
print("Deactivate Maintanance Mode")
|
||||||
update_procedure("docker-compose exec -T -u www-data application /var/www/html/occ maintenance:mode --off")
|
update_procedure("docker-compose exec -T -u www-data application /var/www/html/occ maintenance:mode --off")
|
||||||
|
|
||||||
def update_procedure(command):
|
def update_procedure(command):
|
||||||
@ -243,5 +243,4 @@ if __name__ == "__main__":
|
|||||||
update_nextcloud()
|
update_nextcloud()
|
||||||
|
|
||||||
# @todo implement dedicated procedure for bluesky
|
# @todo implement dedicated procedure for bluesky
|
||||||
# @todo implement dedicated procedure for openproject
|
|
||||||
# @todo implement dedicated procedure for taiga
|
# @todo implement dedicated procedure for taiga
|
||||||
|
Loading…
x
Reference in New Issue
Block a user