From 36c76fd00ea1f9c43ffc0f68a05ce38cef369da9 Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Fri, 14 Mar 2025 12:12:40 +0100 Subject: [PATCH] Optimized .mds and meta/main.yml for systemd-notifier --- roles/systemd-notifier/README.md | 33 +++++++++------------------- roles/systemd-notifier/meta/main.yml | 23 +++++++++++++++++++ 2 files changed, 33 insertions(+), 23 deletions(-) diff --git a/roles/systemd-notifier/README.md b/roles/systemd-notifier/README.md index c1b657e4..444a9f61 100644 --- a/roles/systemd-notifier/README.md +++ b/roles/systemd-notifier/README.md @@ -1,33 +1,20 @@ -# systemd-notifier Ansible Role - -Author: Kevin Veen-Birkenbach (kevin@veen.world) +# Unified Service Failure Notifier ## Description -This Ansible role installs a systemd service that sends notifications via both `systemd-notifier-telegram` and `systemd-notifier-email` when any service fails. +This role installs a systemd service that sends notifications via both [systemd-notifier-telegram](../systemd-notifier-telegram/README.md) and [systemd-notifier-email](../systemd-notifier-email/README.md) when any service fails. -Features include: +## Overview -- Configuration of a systemd service for notification. -- Dependency management for the `systemd-notifier-telegram` and `systemd-notifier-email` roles. +Optimized for prompt and comprehensive failure alerts, this role configures a unified notification service. It leverages the capabilities of both Telegram and Email notifications to ensure that administrators are quickly informed about service issues, enabling rapid troubleshooting. -This role was created as part of a conversation with OpenAI's ChatGPT and can be found [here](https://chat.openai.com/share/96e4ca12-0888-41c0-9cfc-29c0180f0dba). +## Purpose -## Role Dependencies - -This role has the following dependencies: - -- `systemd-notifier-telegram` -- `systemd-notifier-email` +The primary purpose of this role is to provide a centralized mechanism for service failure notifications. By integrating with both the Telegram and Email notifier roles, it delivers reliable alerts through multiple channels, enhancing overall system observability and responsiveness. ## Features -- Installs a systemd service for sending notifications. -- Integrates with both Telegram and Email for notification delivery. - -## Contact Information - -For any questions or feedback, please contact the author: - -Author: Kevin Veen-Birkenbach -Email: kevin@veen.world \ No newline at end of file +- **Unified Notification Service:** Installs a systemd service that triggers both Telegram and Email alerts. +- **Dependency Integration:** Works seamlessly with the [systemd-notifier-telegram](../systemd-notifier-telegram/README.md) and [systemd-notifier-email](../systemd-notifier-email/README.md) roles. +- **Automated Service Management:** Automatically restarts the notifier service upon configuration changes. +- **Centralized Alerting:** Provides a unified approach to monitor and notify about service failures. \ No newline at end of file diff --git a/roles/systemd-notifier/meta/main.yml b/roles/systemd-notifier/meta/main.yml index dd6d3068..8f6804d2 100644 --- a/roles/systemd-notifier/meta/main.yml +++ b/roles/systemd-notifier/meta/main.yml @@ -1,4 +1,27 @@ --- +galaxy_info: + author: "Kevin Veen-Birkenbach" + description: "Installs a unified systemd notification service that sends alerts via both Telegram and Email when a service fails." + 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: + - systemd + - notifier + - telegram + - email + - notifications + repository: "https://s.veen.world/cymais" + issue_tracker_url: "https://s.veen.world/cymaisissues" + documentation: "https://s.veen.world/cymais" dependencies: - role: systemd-notifier-telegram - role: systemd-notifier-email