computer-playbook/roles/sys-hlth-docker-container

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-alm-compose) is triggered.

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-alm-compose role for failure notifications.
• Configurable Script Location: Controlled via the path_administrator_scripts variable.

Further Resources

• Docker Health Checks Documentation
• Systemd Timers Documentation