Files
computer-playbook/roles/sys-ctl-hlth-msmtp/README.md
kevinveenbirkenbachandClaude Opus 5 c55f508e05 feat(readme): draw mandatory and disabled service relations
The cosmos generator linked a consumer to its provider only through an
'<role>' in group_names reference or an explicit provides: name. A hard
dependency has neither -- pinning the provider on unconditionally is
exactly what removes the Jinja reference the generator was reading -- so
web-svc-asset's bond to web-svc-file vanished from the diagram the moment
it became binding. Match a service key against the provider's own primary
key from the registry, in both directions.

Services the role turns off drew a solid 1:1 edge, claiming a mandatory
relationship for something that carries nothing at deploy time. They now
render as a red 0..0 edge; edge merging gained a real precedence so a
provider consumed through two keys stays live when only one is off.

Named colour, not hex: a '#' opens an entity code in the mermaid lexer and
turns the whole diagram into a parse error on GitHub.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-17 18:02:31 +02:00

2.4 KiB

sys-ctl-hlth-msmtp

Description

This Ansible role sends periodic health check emails using msmtp to verify that your mail transport agent is operational. It deploys a simple script and hooks it into a systemd service and timer, with failure notifications sent via Telegram.

Overview

Optimized for Archlinux, this role creates the required directory structure, installs and configures the sys-ctl-hlth-check script, and integrates with the sys-ctl-alm-telegram role. It uses the sys-timer role to schedule regular checks based on your customizable OnCalendar setting.

Cosmos

The diagram places sys-ctl-hlth-msmtp in the Infinito.Nexus cosmos: the components it deploys (capabilities), the central services it consumes (dependencies), and its outward reach (federation and bridged external networks).

flowchart LR
    subgraph role [sys-ctl-hlth-msmtp 💻]
        svc_msmtp["msmtp"]
    end

Solid 1:1 edges are fixed relationships; dashed 0..1 edges are conditional (enabled only in matching deployments); red 0..0 edges are turned off in this role. Node markers show the role's deploy modes (💻 host, 🐳 compose, 🐝 swarm); ❌ marks a service that is explicitly turned off, and ⚙️ an Ansible role dependency declared in meta/main.yml.

Purpose

The sys-ctl-hlth-msmtp role ensures that your mail transport system stays available by sending a test email at defined intervals. If the email fails, a Telegram alert is triggered, allowing you to detect and address issues before they impact users.

Features

  • Directory & Script Deployment: Sets up sys-ctl-hlth-msmtp/ and deploys a templated Bash script to send test emails via msmtp.
  • Systemd Service & Timer: Provides .service and .timer units to run the check and schedule it automatically.
  • Failure Notifications: Leverages sys-ctl-alm-telegram to push alerts when the script exits with an error.
  • Configurable Schedule: Define your desired check frequency using the on_calendar_health_msmtp variable.
  • Email Destination: Specify the recipient via the lookup('users', 'administrator').email variable.

Credits

Implemented by Kevin Veen-Birkenbach. Part of the Infinito.Nexus Project and maintained by Kevin Veen-Birkenbach. Licensed under the Infinito.Nexus Community License (Non-Commercial).