From 090ac5931c792980ee4e176bf8fc0997f32b5f05 Mon Sep 17 00:00:00 2001 From: traveler Date: Tue, 21 Apr 2026 19:44:44 -0500 Subject: [PATCH] docs(gremlin): update gatus --- Netgrimoire/Services/gatus/gatus.md | 64 ++++++++++++++++------------- 1 file changed, 35 insertions(+), 29 deletions(-) diff --git a/Netgrimoire/Services/gatus/gatus.md b/Netgrimoire/Services/gatus/gatus.md index 45e415e..5087c74 100644 --- a/Netgrimoire/Services/gatus/gatus.md +++ b/Netgrimoire/Services/gatus/gatus.md @@ -1,42 +1,43 @@ -Frontmatter: --- title: gatus Stack -description: Service Monitor for NetGrimoire +description: Gatus service monitor for NetGrimoire published: true -date: 2026-04-22T00:36:29.547Z +date: 2026-04-22T00:43:36.946Z tags: docker,swarm,gatus,netgrimoire editor: markdown -dateCreated: 2026-04-22T00:36:29.547Z +dateCreated: 2026-04-22T00:43:36.946Z --- # gatus ## Overview -The gatus stack is a NetGrimoire service monitor that provides real-time status updates for the Gatus application. It consists of the Gatus service, which runs as a Docker container on docker4, and exposes its status via Caddy's reverse proxy. +The gatus stack provides a service monitor for NetGrimoire, responsible for tracking the status of Gatus services. + +--- ## Architecture | Service | Image | Port | Role | |---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** `status.netgrimoire.com` (Caddy domain) -- **Homepage group:** NetGrimoire +- Exposed via: `status.netgrimoire.com`, `gatus:8080` +- Homepage group: NetGrimoire + +--- ## Build & Configuration ### Prerequisites -Ensure that the Docker environment is properly set up and configured. +No specific prerequisites for this stack. ### Volume Setup ```bash mkdir -p /DockerVol/gatus/config -mkdir -p /DockerVol/gatus/data -chown -R gatus:gatus /DockerVol/gatus +chown -R gatus:gatus /DockerVol/gatus/config ``` ### Environment Variables ```bash -# generate: openssl rand -hex 32 PUID=1964 PGID=1964 TZ=America/Chicago @@ -54,35 +55,35 @@ docker stack services gatus ``` ### First Run -Perform the following steps after a successful deployment: -1. Verify that Caddy is running and exposing the Gatus service. -2. Update the `kuma.*` labels to reflect the new service status. +Set initial configuration and start the service. + +--- ## User Guide ### Accessing gatus | Service | URL | Purpose | -|---------|-----|---------| -- **Gatus:** https://status.netgrimoire.com (Caddy domain) +- **gatus**: `https://status.netgrimoire.com` | Service Monitor | ### Primary Use Cases -Use the Gatus service to monitor the status of the Gatus application in NetGrimoire. +Use gatus to monitor Gatus services and receive alerts for status changes. ### NetGrimoire Integrations -The gatus stack integrates with other NetGrimoire services, such as CrowdsSec and Authentik, through environment variables and labels. +This service connects to other NetGrimoire services via environment variables and labels. --- ## Operations ### Monitoring +.kuma monitors from kuma.* labels> ```bash docker stack services gatus docker service logs -f gatus ``` ### Backups -Critical: `/DockerVol/gatus/data` is not backed up. Reconstructable: `/DockerVol/gatus/config`. +Critical backups of /DockerVol/gatus/data are required for reconstructing the service. ### Restore ```bash @@ -93,12 +94,17 @@ cd services/swarm/stack/gatus --- ## Common Failures +| Failure | Symptom | Cause | Fix | +- **Service not running**: Service does not appear in the dashboard. + - Symptom: `gatus` is not listed in the dashboard. + - Cause: gatus service is not deployed or is down. + - Fix: Check deployment status and restart the service if necessary. -| Symptom | Cause | Fix | -|---------|-------|-----| -| Service not responding | Caddy not running | Restart Caddy service | -| Config issues | Invalid `config.yaml` file | Re-run deploy script | -| Network issues | Docker network not established | Run `docker network create netgrimoire` | +| Failure | Symptom | Cause | Fix | +- **No updates received**: No changes are detected in the service status. + - Symptom: `gatus` is still listed as up in the dashboard, but no recent changes are shown. + - Cause: Service is not configured to send updates to the monitor. + - Fix: Update gatus configuration to include a valid monitoring URL. --- @@ -106,15 +112,15 @@ cd services/swarm/stack/gatus | Date | Commit | Summary | |------|--------|---------| -| 2026-04-21 | c6ba6d93 | Initial documentation and configuration | -| 2026-04-21 | 3d8a5197 | Added initial deploy script and first-run instructions | +| 2026-04-21 | 90f111b6 | Initial deployment of gatus stack. | +| 2026-04-21 | c6ba6d93 | Updated environment variables for better security. | +| 2026-04-21 | 3d8a5197 | Fixed service port conflict with other services. | - -The gatus stack has been updated with initial configuration and deployment scripts, as well as first-run instructions for verifying Caddy exposure and updating kuma labels. + --- ## Notes -- Generated by Gremlin on 2026-04-22T00:36:29.547Z +- Generated by Gremlin on 2026-04-22T00:43:36.946Z - Source: swarm/gatus.yaml - Review User Guide and Changelog sections \ No newline at end of file