Files
computer-playbook/roles/sys-ctl-alm-telegram
Kevin Veen-Birkenbach e09f561f0b Refactor run-once orchestration and bootstrap Mailu/Mastodon in a single deploy
- Replace legacy utils/run_once.yml with the new helpers utils/once_flag.yml and utils/once_finalize.yml
- Introduce utils/compose_up.yml to ensure docker-compose stacks are up and to flush handlers safely without coupling to run-once flags
- Migrate all affected roles (desk-*, dev-*, sys-ctl-*, sys-svc-*, web-app-*, web-svc-*, util-*) to the new run-once helpers
- Rework sys-svc-msmtp to auto-load Mailu once per deploy, check reachability, and reuse the running stack instead of requiring multiple playbook passes
- Adjust web-app-mailu to integrate cert deployment, handler flushing, and run-once handling so Mailu is fully initialized in a single deploy
- Improve Matomo, CDN, logout and CSP/health-check related roles to cooperate with the new compose_up / once_* pattern
- Simplify alarm/backup/timer/service orchestration (sys-ctl-alm-*, sys-bkp-provider, sys-timer-cln-bkps, etc.) by moving run-once logic into dedicated 01_core.yml files
- Update integration tests so utils/once_flag.yml and utils/once_finalize.yml are recognised as valid run-once providers, keeping the global run_once_* guarantees consistent
- Align frontend injection and service dependencies so Mastodon- and Mailu-related services can be brought up coherently within a single deployment cycle rather than several iterations
2025-12-01 13:30:50 +01:00
..

Automated Telegram Alerts for Service Failures

Description

This role installs and configures the necessary components for sending notifications via systemd when a service fails. It sets up the sys-ctl-alm-telegram service and configures parameters and customizable templates for sending messages through Telegram.

Overview

Optimized for real-time alerts, this role is a key component of the overall sys-ctl-alm-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

The primary purpose of this role is to provide a robust solution for automated Telegram notifications in a systemd environment. By integrating with Telegrams Bot API and using customizable message templates, it delivers clear and timely alerts about service failures, thereby enhancing system observability and reliability.

Features

  • 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 sys-ctl-alm-compose suite which includes related roles such as sys-ctl-alm-email and others.

Other Resources

This role was developed as part of a conversation with OpenAI's ChatGPT and can be found here.