Renamed alert-bot to alert-compose

This commit is contained in:
Kevin Veen-Birkenbach 2025-07-09 00:11:41 +02:00
parent 8da2e41463
commit 7362accab0
No known key found for this signature in database
GPG Key ID: 44D8F11FD62F878E
61 changed files with 67 additions and 67 deletions

View File

@ -1,6 +1,6 @@
- name: "restart alert-core service"
- name: "restart alert-compose service"
systemd:
name: alert-core.cymais.service
name: alert-compose.cymais.service
daemon_reload: yes
when: run_once_systemd_notifier_service is not defined

View File

@ -1,9 +1,9 @@
---
- name: configure alert-core.cymais@.service
- name: configure alert-compose.cymais@.service
template:
src: alert-core@.service.j2
dest: "/etc/systemd/system/alert-core.cymais@.service"
notify: "restart alert-core service"
src: alert-compose@.service.j2
dest: "/etc/systemd/system/alert-compose.cymais@.service"
notify: "restart alert-compose service"
when: run_once_systemd_notifier_service is not defined
- name: run the systemd_notifier_service tasks once

View File

@ -6,7 +6,7 @@ This role installs and configures the necessary components for sending email not
## Overview
Optimized for secure and reliable service failure notifications, this role is an integral part of the overall `alert-core` suite. It ensures that, upon failure of a critical service, an email alert is sent automatically to enable prompt troubleshooting.
Optimized for secure and reliable service failure notifications, this role is an integral part of the overall `alert-compose` suite. It ensures that, upon failure of a critical service, an email alert is sent automatically to enable prompt troubleshooting.
## Purpose
@ -17,7 +17,7 @@ The primary purpose of this role is to provide a comprehensive solution for auto
- **Service Installation & Configuration:** Installs msmtp and configures the email sending service.
- **Customizable Templates:** Supports tailoring email templates for service failure notifications.
- **Secure Notifications:** Integrates with systemd to trigger email alerts when services fail.
- **Suite Integration:** Part of the `alert-core` suite, offering a unified approach to service failure notifications.
- **Suite Integration:** Part of the `alert-compose` suite, offering a unified approach to service failure notifications.
## Other Resources

View File

@ -1,7 +1,7 @@
---
galaxy_info:
author: "Kevin Veen-Birkenbach"
description: "Installs and configures components for sending email notifications. This role is part of the alert-core suite, providing automated alerts when services fail."
description: "Installs and configures components for sending email notifications. This role is part of the alert-compose suite, providing automated alerts when services fail."
license: "CyMaIS NonCommercial License (CNCL)"
license_url: "https://s.veen.world/cncl"
company: |

View File

@ -6,7 +6,7 @@ This role installs and configures the necessary components for sending notificat
## Overview
Optimized for real-time alerts, this role is a key component of the overall [`alert-core` suite](../). It ensures that, upon failure of a critical service, a Telegram message is automatically sent to notify administrators and enable prompt troubleshooting.
Optimized for real-time alerts, this role is a key component of the overall [`alert-compose` suite](../). It ensures that, upon failure of a critical service, a Telegram message is automatically sent to notify administrators and enable prompt troubleshooting.
## Purpose
@ -17,7 +17,7 @@ The primary purpose of this role is to provide a robust solution for automated T
- **Service Installation & Configuration:** Installs and configures necessary components (including the `curl` package).
- **Customizable Templates:** Supports tailored Telegram message templates for service failure notifications.
- **Secure Notifications:** Leverages systemd to trigger alerts automatically when services fail.
- **Suite Integration:** Part of the [`alert-core` suite](../) which includes related roles such as [alert-email](../alert-email/README.md) and others.
- **Suite Integration:** Part of the [`alert-compose` suite](../) which includes related roles such as [alert-email](../alert-email/README.md) and others.
## Other Resources

View File

@ -1,7 +1,7 @@
---
galaxy_info:
author: "Kevin Veen-Birkenbach"
description: "Installs and configures components for sending Telegram notifications through systemd. This role is part of the alert-core suite, providing automated alerts when services fail."
description: "Installs and configures components for sending Telegram notifications through systemd. This role is part of the alert-compose suite, providing automated alerts when services fail."
license: "CyMaIS NonCommercial License (CNCL)"
license_url: "https://s.veen.world/cncl"
company: |

View File

@ -1,7 +1,7 @@
[Unit]
Description=Backup to USB when mounted to {{ backup_to_usb_mount }}
Wants={{systemctl_mount_service_name}}
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -24,7 +24,7 @@ galaxy_info:
documentation: "https://s.veen.world/cymais"
dependencies:
- backup-provider
- alert-core
- alert-compose
- cleanup-failed-docker-backups
- maintenance-lock
- backup-directory-validator

View File

@ -1,6 +1,6 @@
[Unit]
Description=backup docker volumes to local folder
OnFailure=alert-core.cymais@%n.service cleanup-failed-docker-backups.cymais.service
OnFailure=alert-compose.cymais@%n.service cleanup-failed-docker-backups.cymais.service
[Service]
Type=oneshot

View File

@ -1,6 +1,6 @@
[Unit]
Description=backup docker volumes to local folder
OnFailure=alert-core.cymais@%n.service cleanup-failed-docker-backups.cymais.service
OnFailure=alert-compose.cymais@%n.service cleanup-failed-docker-backups.cymais.service
[Service]
Type=oneshot

View File

@ -26,7 +26,7 @@ galaxy_info:
documentation: "https://s.veen.world/cymais"
dependencies:
- generic-git
- alert-core
- alert-compose
- cleanup-backups-timer
- cleanup-failed-docker-backups
- maintenance-lock

View File

@ -1,6 +1,6 @@
[Unit]
Description=pull remote backups
OnFailure=alert-core.cymais@%n.service cleanup-failed-docker-backups.cymais.service
OnFailure=alert-compose.cymais@%n.service cleanup-failed-docker-backups.cymais.service
[Service]
Type=oneshot

View File

@ -10,7 +10,7 @@ Optimized for effective disk space management, this role:
- Installs required packages (e.g. [lsof](https://en.wikipedia.org/wiki/Lsof) and [psutil](https://pypi.org/project/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 [alert-core](../alert-core/README.md).
- Configures a systemd service to run the cleanup script, with notifications via [alert-compose](../alert-compose/README.md).
## Purpose

View File

@ -23,5 +23,5 @@ galaxy_info:
documentation: "https://s.veen.world/cymais"
dependencies:
- generic-python-pip
- alert-core
- alert-compose
- maintenance-lock

View File

@ -1,6 +1,6 @@
[Unit]
Description=delete old backups
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -9,7 +9,7 @@ This Ansible role automates the detection, revocation and deletion of unused Let
- Installs the `certreap` cleanup tool using the `pkgmgr-install` role
- Deploys and configures a `cleanup-certs.cymais.service` systemd unit
- (Optionally) Sets up a recurring cleanup via a systemd timer using the `generic-timer` role
- Integrates with `alert-core` to send failure notifications
- Integrates with `alert-compose` to send failure notifications
- Ensures idempotent execution with a `run_once_cleanup_certs` flag
## Features
@ -27,7 +27,7 @@ This Ansible role automates the detection, revocation and deletion of unused Let
Prevents multiple runs in one play by setting a `run_once_cleanup_certs` fact.
- **Failure Notification**
Triggers `alert-core.cymais@cleanup-certs.cymais.service` on failure.
Triggers `alert-compose.cymais@cleanup-certs.cymais.service` on failure.
## Further Resources

View File

@ -24,4 +24,4 @@ galaxy_info:
documentation: "https://github.com/kevinveenbirkenbach/certreap#readme"
dependencies:
- alert-core
- alert-compose

View File

@ -1,6 +1,6 @@
[Unit]
Description=Detect, revoke, and delete unused Let's Encrypt certificates based on active NGINX configuration files.
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -22,5 +22,5 @@ galaxy_info:
issue_tracker_url: "https://s.veen.world/cymaisissues"
documentation: "https://s.veen.world/cymais"
dependencies:
- alert-core
- alert-compose
- maintenance-lock

View File

@ -1,6 +1,6 @@
[Unit]
Description=freeing disc space
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -22,6 +22,6 @@ galaxy_info:
issue_tracker_url: "https://s.veen.world/cymaisissues"
documentation: "https://s.veen.world/cymais"
dependencies:
- alert-core
- alert-compose
- maintenance-lock
- backup-directory-validator

View File

@ -1,6 +1,6 @@
[Unit]
Description=Cleaning up failed docker volume backups
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -9,4 +9,4 @@ galaxy_info:
- all
dependencies:
- generic-aur-helper
- alert-core
- alert-compose

View File

@ -1,6 +1,6 @@
[Unit]
Description=Keyboard Color Service
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -21,4 +21,4 @@ The primary purpose of this role is to maintain optimal performance of Btrfs fil
- **Repository Cloning:** Automatically fetches the latest auto-btrfs-balancer repository.
- **Service Configuration:** Sets up a systemd service for running the balancing script.
- **Timer Integration:** Schedules the balancing process via a systemd timer.
- **Error Notification:** Notifies on failure using alert-core.
- **Error Notification:** Notifies on failure using alert-compose.

View File

@ -22,4 +22,4 @@ galaxy_info:
issue_tracker_url: "https://s.veen.world/cymaisissues"
documentation: "https://s.veen.world/cymais"
dependencies:
- alert-core
- alert-compose

View File

@ -1,6 +1,6 @@
[Unit]
Description=auto balance btrfs
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -1,6 +1,6 @@
[Unit]
Description=restart unhealthy docker containers
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -1,6 +1,6 @@
[Unit]
Description=Restart Docker Instances
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -1,6 +1,6 @@
[Unit]
Description=Optimize storage paths
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -7,10 +7,10 @@ Checks the health of all mounted Btrfs filesystems by inspecting device error co
- Iterates over every Btrfs filesystem.
- Runs `btrfs device stats` and alerts if any error counters are non-zero.
- Hooks into systemd and a timer for regular checks.
- On failure, calls `alert-core.cymais@…` for notification.
- On failure, calls `alert-compose.cymais@…` for notification.
## Usage
Just include this role in your playbook; it will:
1. Deploy a small shell script under `{{ path_administrator_scripts }}/monitor-bot-btrfs/`.
2. Install a `.service` and `.timer` unit.
3. Send alerts via `alert-core` if any filesystem shows errors.
3. Send alerts via `alert-compose` if any filesystem shows errors.

View File

@ -21,4 +21,4 @@ galaxy_info:
repository: "https://s.veen.world/cymais"
documentation: "https://s.veen.world/cymais"
dependencies:
- alert-core
- alert-compose

View File

@ -1,6 +1,6 @@
[Unit]
Description=Check btrfs status
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -13,7 +13,7 @@ Designed for Archlinux systems, this role periodically checks whether web resour
- **CSP Resource Validation:** Uses Puppeteer to simulate browser requests and detect blocked resources.
- **Domain Extraction:** Parses all `.conf` files in the NGINX config folder to determine the list of domains to check.
- **Automated Execution:** Registers a systemd service and timer for recurring health checks.
- **Error Notification:** Integrates with `alert-core` for alerting on failure.
- **Error Notification:** Integrates with `alert-compose` for alerting on failure.
## License

View File

@ -24,4 +24,4 @@ galaxy_info:
issue_tracker_url: "https://s.veen.world/cymaisissues"
documentation: "https://s.veen.world/cymais"
dependencies:
- alert-core
- alert-compose

View File

@ -1,6 +1,6 @@
[Unit]
Description=Check for CSP-blocked resources via Puppeteer
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -6,5 +6,5 @@ Monitors disk-space usage and alerts if any filesystem usage exceeds your define
## Features
- Uses `df` to gather current usage.
- Compares against `size_percent_disc_space_warning` threshold.
- Sends failure alerts via `alert-core`.
- Sends failure alerts via `alert-compose`.
- Runs on a configurable systemd timer.

View File

@ -21,4 +21,4 @@ galaxy_info:
repository: "https://s.veen.world/cymais"
documentation: "https://s.veen.world/cymais"
dependencies:
- alert-core
- alert-compose

View File

@ -1,6 +1,6 @@
[Unit]
Description=checking disc space
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -18,4 +18,4 @@ This Ansible role is designed to ensure the health of Docker containers running
To use this role, include it in your playbook and set the `path_administrator_scripts` variable to the desired path for the health check scripts.
Ensure that the `alert-core` dependency is satisfied for error notifications.
Ensure that the `alert-compose` dependency is satisfied for error notifications.

View File

@ -21,4 +21,4 @@ galaxy_info:
repository: "https://s.veen.world/cymais"
documentation: "https://s.veen.world/cymais"
dependencies:
- alert-core
- alert-compose

View File

@ -1,6 +1,6 @@
[Unit]
Description=Checking docker health
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -18,7 +18,7 @@ This role checks for anonymous Docker volumes that are not bound to a container
Include this role in your playbook and set the `path_administrator_scripts` variable to determine where the health check scripts should reside. Define `whitelisted_anonymous_volumes` in `vars/main.yml` with an array of volume IDs that should be ignored by the health check.
Ensure that the `alert-core` dependency is satisfied for error notifications.
Ensure that the `alert-compose` dependency is satisfied for error notifications.
## Created with AI
This script was created with the help of AI. The full conversation you find [here](https://chat.openai.com/share/1fa829f1-f001-4111-b1d4-1b2e3d583da2).

View File

@ -21,4 +21,4 @@ galaxy_info:
repository: "https://s.veen.world/cymais"
documentation: "https://s.veen.world/cymais"
dependencies:
- alert-core
- alert-compose

View File

@ -1,6 +1,6 @@
[Unit]
Description=Checking docker health
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -7,7 +7,7 @@ Scans `journalctl` over the last day for “error” entries and alerts if any a
- Runs `journalctl --since '1 day ago' | grep -i error`.
- Exits non-zero on matches.
- Scheduled via systemd timer.
- Alerts via `alert-core` on detection.
- Alerts via `alert-compose` on detection.
## Usage
Include the role; set `on_calendar_health_journalctl` for your preferred schedule.

View File

@ -21,4 +21,4 @@ galaxy_info:
repository: "https://s.veen.world/cymais"
documentation: "https://s.veen.world/cymais"
dependencies:
- alert-core
- alert-compose

View File

@ -1,6 +1,6 @@
[Unit]
Description=checking journalctl health
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -6,7 +6,7 @@ Verifies that each of your Nginxserved domains returns an expected HTTP statu
## Features
- Scans your `nginx` server block `.conf` files for domains.
- HEAD-requests each domain and compares against per-domain expected codes.
- Reports any mismatches via `alert-core`.
- Reports any mismatches via `alert-compose`.
- Scheduled via a systemd timer for periodic health sweeps.
## Usage

View File

@ -23,4 +23,4 @@ galaxy_info:
documentation: "https://s.veen.world/cymais"
dependencies:
- generic-python-pip
- alert-core
- alert-compose

View File

@ -1,6 +1,6 @@
[Unit]
Description=Check nginx configuration status
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -1,6 +1,6 @@
[Unit]
Description=Updates Docker Instances
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -13,7 +13,7 @@ This Ansible role simplifies the deployment of **Let's Encrypt certificates** in
- Automatically **reloads or restarts Nginx services** when certificates are updated.
- **Configures and manages a `systemd` service** for automated certificate deployment.
- **Includes a `systemd` timer** for scheduled renewals.
- **Handles dependent services** like `alert-core`.
- **Handles dependent services** like `alert-compose`.
---

View File

@ -1,2 +1,2 @@
dependencies:
- alert-core
- alert-compose

View File

@ -1,6 +1,6 @@
[Unit]
Description=Let's Encrypt deploy to {{docker_compose.directories.instance}}
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot

View File

@ -11,7 +11,7 @@ Optimized for Archlinux systems, this role installs the `certbot-nginx` package,
### Key Features
- **Automatic Renewal:** Schedules unattended certificate renewals using generic-timers.
- **Seamless Nginx Reload:** Reloads the Nginx service automatically after successful renewals.
- **Systemd Integration:** Manages renewal operations reliably with `systemd` and `alert-core`.
- **Systemd Integration:** Manages renewal operations reliably with `systemd` and `alert-compose`.
- **Quiet and Safe Operation:** Uses `--quiet` and `--agree-tos` flags to ensure non-interactive renewals.
## 🎯 Purpose
@ -23,7 +23,7 @@ The Nginx Certbot Automation role ensures that Let's Encrypt SSL/TLS certificate
- **Certbot-Nginx Package Installation:** Installs required certbot plugins for Nginx.
- **Custom Systemd Service:** Configures a lightweight, dedicated renewal service.
- **Timer Setup:** Uses generic-timer to run certbot renewals periodically.
- **Failure Notification:** Integrated with `alert-core` for alerting on failures.
- **Failure Notification:** Integrated with `alert-compose` for alerting on failures.
## 🔗 Learn More

View File

@ -29,5 +29,5 @@ galaxy_info:
dependencies:
- generic-certbot
- webserver-core
- alert-core
- alert-compose
- cleanup-certs

View File

@ -1,6 +1,6 @@
[Unit]
Description=Let's Encrypt renewal
OnFailure=alert-core.cymais@%n.service
OnFailure=alert-compose.cymais@%n.service
[Service]
Type=oneshot