Files
computer-playbook/roles/sys-ctl-hlth-container/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.5 KiB

Docker Container Health Check

Description

This role monitors the health status of Docker containers on the system. It detects containers that are either unhealthy or have exited with a non-zero code, and triggers alerts if issues are found.

Overview

The role installs a health check script along with a systemd service and timer to run these checks at scheduled intervals.
If unhealthy or failed containers are detected, the configured failure notifier (via sys-ctl-alm-compose) is triggered.

Cosmos

The diagram places Docker Container Health Check 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-container 💻]
        svc_container["container"]
    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 primary purpose of this role is to ensure that Docker-based services remain operational. By automatically monitoring container health, it enables administrators to react quickly to failures, reducing downtime and preventing unnoticed service degradation.

Features

  • Automated Health Checks: Detects containers in unhealthy state or exited with non-zero exit codes.
  • Systemd Integration: Installs a one-shot service and timer to run health checks on a schedule.
  • Alerting Support: Works with the sys-ctl-alm-compose role for failure notifications.
  • Configurable Script Location: Controlled via the PATH_ADMINISTRATOR_SCRIPTS variable.

Further Resources

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).