mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-04-02 15:24:17 +02:00
Optimized .mds and meta/main.yml for systemd-notifier-email
This commit is contained in:
parent
0ee2c041a6
commit
e9aef3468e
@ -1,40 +1,24 @@
|
|||||||
# systemd-notifier-email Ansible Role
|
# Automated Email Alerts for Service Failures
|
||||||
|
|
||||||
Author: Kevin Veen-Birkenbach (kevin@veen.world)
|
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
This Ansible role installs the necessary components for sending email notifications through systemd when any service fails. It configures the `systemd-notifier-email` service and handles the setup of email parameters and templates.
|
This role installs and configures the necessary components for sending email notifications via systemd when a service fails. It sets up the `systemd-notifier-email` service and configures email parameters and templates using msmtp.
|
||||||
|
|
||||||
Features include:
|
## Overview
|
||||||
|
|
||||||
- Installation and configuration of an email sending service.
|
Optimized for secure and reliable service failure notifications, this role is an integral part of the overall `systemd-notifier` suite. It ensures that, upon failure of a critical service, an email alert is sent automatically to enable prompt troubleshooting.
|
||||||
- Customizable email templates for service failure notifications.
|
|
||||||
|
|
||||||
This role is part of the `systemd-notifier` suite, which provides a comprehensive solution for service failure notifications in a systemd environment.
|
## Purpose
|
||||||
|
|
||||||
|
The primary purpose of this role is to provide a comprehensive solution for automated email notifications in a systemd environment. By integrating with msmtp and customizable templates, it delivers clear and timely alerts about service failures, thereby enhancing system reliability.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **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 `systemd-notifier` suite, offering a unified approach to service failure notifications.
|
||||||
|
|
||||||
|
## Further Information
|
||||||
|
|
||||||
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).
|
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).
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
This role has the following requirements:
|
|
||||||
|
|
||||||
- Access to an SMTP server for sending email notifications.
|
|
||||||
- Availability of the `msmtp` package on the target system.
|
|
||||||
|
|
||||||
## Role Variables
|
|
||||||
|
|
||||||
The following variables can be customized in the role's `vars/main.yml` file:
|
|
||||||
|
|
||||||
- `systemd_notifier_email_folder`: The path to the folder where email-related scripts and configurations will be stored.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
To use this role, include it as a dependency in your playbook or role that requires email notifications. Ensure that the `systemd-notifier-email` role is correctly referenced and configured.
|
|
||||||
|
|
||||||
## Contact Information
|
|
||||||
|
|
||||||
For any questions or feedback, please contact the author:
|
|
||||||
|
|
||||||
Author: Kevin Veen-Birkenbach
|
|
||||||
Email: kevin@veen.world
|
|
25
roles/systemd-notifier-email/meta/main.yml
Normal file
25
roles/systemd-notifier-email/meta/main.yml
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
---
|
||||||
|
galaxy_info:
|
||||||
|
author: "Kevin Veen-Birkenbach"
|
||||||
|
description: "Installs and configures components for sending email notifications through systemd using msmtp. This role is part of the systemd-notifier suite, providing automated alerts when services fail."
|
||||||
|
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:
|
||||||
|
- email
|
||||||
|
- systemd
|
||||||
|
- notifications
|
||||||
|
- automation
|
||||||
|
- msmtp
|
||||||
|
repository: "https://s.veen.world/cymais"
|
||||||
|
issue_tracker_url: "https://s.veen.world/cymaisissues"
|
||||||
|
documentation: "https://s.veen.world/cymais"
|
||||||
|
dependencies: []
|
Loading…
x
Reference in New Issue
Block a user