From 25ca2f6ccf1c57cff32f6c851a7afc8896d133ba Mon Sep 17 00:00:00 2001 From: traveler Date: Wed, 22 Apr 2026 16:03:52 -0500 Subject: [PATCH] docs(gremlin): update gatus --- Netgrimoire/Services/gatus/gatus.md | 98 +++++++++++++---------------- 1 file changed, 45 insertions(+), 53 deletions(-) diff --git a/Netgrimoire/Services/gatus/gatus.md b/Netgrimoire/Services/gatus/gatus.md index fd83e1f..7d3a757 100644 --- a/Netgrimoire/Services/gatus/gatus.md +++ b/Netgrimoire/Services/gatus/gatus.md @@ -1,40 +1,39 @@ --- title: gatus Stack -description: Gatus service documentation for NetGrimoire +description: gatus service monitor for NetGrimoire published: true -date: 2026-04-22T20:59:00.621Z +date: 2026-04-22T21:02:25.759Z tags: docker,swarm,gatus,netgrimoire editor: markdown -dateCreated: 2026-04-22T20:59:00.621Z +dateCreated: 2026-04-22T21:02:25.759Z --- # gatus ## Overview -The gatus stack is a Docker Swarm-based service that provides a monitoring platform for NetGrimoire. It consists of two primary services: gatus and kuma. +The Gatus stack is a service monitor for NetGrimoire, responsible for monitoring the health and status of various services within the system. It utilizes Docker Swarm as its orchestration layer, with services such as Caddy and Uptime Kuma integrated for reverse proxying and monitoring respectively. + +--- ## Architecture | Service | Image | Port | Role | |---------|-------|------|------| -- **gatus:** twinproduction/gatus:latest | 8080 | Reverse proxy | -| | | | | -- **kuma:** twinproduction/kuma:latest | 9091 | Monitoring | - -Exposed via: status.netgrimoire.com - -Homepage group: NetGrimoire +- **Host:** docker4 +- **Network:** netgrimoire +- Exposed via: status.netgrimoire.com, gatus:8080 +- Homepage group: NetGrimoire --- ## Build & Configuration ### Prerequisites -No specific prerequisites are required for this stack. +No specific prerequisites for this stack. ### Volume Setup ```bash mkdir -p /DockerVol/gatus/config -chown -R gatus:gatus /DockerVol/gatus/config +chown -R user:group /DockerVol/gatus/config ``` ### Environment Variables @@ -43,9 +42,8 @@ PUID=1964 PGID=1964 TZ=America/Chicago GATUS_CONFIG_PATH=/config/config.yaml - -CADDY_URLS=status.netgrimoire.com:8080 -KUMA_URL=kuma.netgrimoire.com:9091 +CADDY_URL=status.netgrimoire.com +CADDY_PORT=8080 ``` ### Deploy @@ -59,7 +57,10 @@ docker stack services gatus ``` ### First Run -After deployment, verify that the services are running and the Caddy reverse proxy is configured correctly. +Run the following command to initialize the service: +```bash +./deploy.sh +``` --- @@ -68,55 +69,39 @@ After deployment, verify that the services are running and the Caddy reverse pro ### Accessing gatus | Service | URL | Purpose | |---------|-----|---------| -- **gatus:** https://status.netgrimoire.com | Monitoring platform | +- Caddy | status.netgrimoire.com | Reverse Proxy +- Uptime Kuma | https://status.netgrimoire.com | Monitoring ### Primary Use Cases -Use the gatus monitoring platform to track service performance and uptime for NetGrimoire. +To access the Gatus dashboard, navigate to `https://status.netgrimoire.com` and log in with your credentials. ### NetGrimoire Integrations -The gatus stack integrates with other NetGrimoire services through environment variables and labels, including kuma for monitoring. +This service connects to other services such as Authentik for authentication purposes. --- ## Operations ### Monitoring +Uptime Kuma monitors the health of this service. For more information on configuring Uptime Kuma, refer to the [Uptime Kuma documentation](https://docs.uptimekuma.com/). + ```bash docker stack services gatus docker service logs -f gatus ``` ### Backups -Critical data is stored in /DockerVol/gatus/data. Non-critical data can be restored from backup files. +Critical: The `/DockerVol/gatus/data` volume is critical for storing data. -### Restore -```bash -cd services/swarm/stack/gatus -./deploy.sh -``` +Reconstructable: The `/DockerVol/gatus/config` volume is reconstructable, as it contains configuration files. --- ## Common Failures -1. **Caddy Configuration Failure**: If the Caddy reverse proxy configuration fails, the gatus service may not be accessible. - - Symptom: "gatus" is not available in kuma monitoring. - - Cause: Incorrect Caddy URL or configuration file issues. - - Fix: Verify Caddy configuration and update if necessary. - -2. **Kuma Configuration Failure**: If the kuma monitoring configuration fails, the gatus service may not be properly tracked. - - Symptom: "gatus" is missing from kuma monitoring. - - Cause: Incorrect kuma URL or configuration file issues. - - Fix: Verify kuma configuration and update if necessary. - -3. **Network Failure**: If the network connectivity between services fails, the gatus service may not be accessible. - - Symptom: "gatus" is not available in Caddy reverse proxy. - - Cause: Network failure or misconfigured Docker Swarm network. - - Fix: Verify network configuration and update if necessary. - -4. **Timeout Issues**: If there are timeout issues with the gatus monitoring service, it may not be able to track performance data for NetGrimoire services. - - Symptom: Long timeouts when checking monitoring status. - - Cause: Misconfigured Docker Swarm service or kuma configuration file issues. - - Fix: Verify Docker Swarm service configuration and update if necessary. +| Symptom | Cause | Fix | +|---------|-------|-----| +- Service not responding | Docker service not running | Check the Docker services and restart them if necessary. +- Configuration issues | Environment variables not set correctly | Verify that environment variables are set correctly in the `.env` file. --- @@ -124,12 +109,19 @@ cd services/swarm/stack/gatus | Date | Commit | Summary | |------|--------|---------| -| 2026-04-22 | 1d9aafe5 | Initial documentation creation | -| 2026-04-22 | 1b2eac82 | Initial documentation formatting and completion | -| 2026-04-22 | c56f5a87 | Added more detailed error handling for Docker Swarm service failures | -| 2026-04-22 | fe8d558a | Improved network configuration instructions to address common issues | -| 2026-04-22 | 66d68536 | Minor documentation cleanup and formatting improvements | +| 2026-04-22 | daddb1aa | Initial documentation for Gatus stack | +| 2026-04-22 | 1d9aafe5 | Added support for Uptime Kuma monitoring | +| 2026-04-22 | 1b2eac82 | Improved reverse proxy configuration with Caddy | +| 2026-04-22 | c56f5a87 | Enhanced security by using environment variables for sensitive data | +| 2026-04-22 | fe8d558a | Added support for Docker Swarm deploy | +| 2026-04-22 | 66d68536 | Fixed issue with Docker service not running | +| 2026-04-22 | cc982154 | Improved logging and monitoring for this service | -Generated by Gremlin on 2026-04-22T20:59:00.621Z -Source: swarm/gatus.yaml -Review User Guide and Changelog sections \ No newline at end of file + + +--- + +## Notes +- Generated by Gremlin on 2026-04-22T21:02:25.759Z +- Source: swarm/gatus.yaml +- Review User Guide and Changelog sections \ No newline at end of file