traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update gatus

Browse source
This commit is contained in:
traveler 2026-04-22 14:55:20 -05:00
parent 090ac5931c
commit 3cc5e7bdbc
1 changed files with 31 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

65
Netgrimoire/Services/gatus/gatus.md
View file

@ -1,39 +1,38 @@
--- ---
title: gatus Stack title: gatus Stack
description: Gatus service monitor for NetGrimoire description: Gatus Service Monitor
published: true published: true
date: 2026-04-22T00:43:36.946Z date: 2026-04-22T19:54:10.748Z
tags: docker,swarm,gatus,netgrimoire tags: docker,swarm,gatus,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-22T00:43:36.946Z dateCreated: 2026-04-22T19:54:10.748Z
--- ---
# gatus # gatus
## Overview ## Overview
The gatus stack provides a service monitor for NetGrimoire, responsible for tracking the status of Gatus services. The gatus stack is a service monitor that provides real-time monitoring and alerts for the NetGrimoire ecosystem. It utilizes Docker Swarm to deploy the Gatus application, which integrates with Caddy as a reverse proxy and Uptime Kuma for monitoring.
--- ---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |- **Host:** docker4 |
- **Host:** docker4 |- **Network:** netgrimoire |
- **Network:** netgrimoire |- **Exposed via:** status.netgrimoire.com, gatus:8080 |
- Exposed via: `status.netgrimoire.com`, `gatus:8080` |- **Homepage group:** NetGrimoire |
- Homepage group: NetGrimoire
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites for this stack. This stack requires a Docker Swarm manager and worker node setup.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/gatus/config mkdir -p /DockerVol/gatus/config
chown -R gatus:gatus /DockerVol/gatus/config chown -R docker:docker /DockerVol/gatus/config
``` ```
### Environment Variables ### Environment Variables
@ -55,7 +54,10 @@ docker stack services gatus
``` ```
### First Run ### First Run
Set initial configuration and start the service. Run the following command to initialize the database and start the service:
```bash
./deploy.sh
```
--- ---
@ -63,48 +65,40 @@ Set initial configuration and start the service.
### Accessing gatus ### Accessing gatus
| Service | URL | Purpose | | Service | URL | Purpose |
- **gatus**: `https://status.netgrimoire.com` | Service Monitor | |- **Status**: status.netgrimoire.com |
|- **Gatus Dashboard**: https://status.netgrimoire.com |
### Primary Use Cases ### Primary Use Cases
Use gatus to monitor Gatus services and receive alerts for status changes. To access the Gatus dashboard, navigate to the provided URL. This will provide an overview of the service's health and performance.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to other NetGrimoire services via environment variables and labels. The gatus stack integrates with other services in the NetGrimoire ecosystem via environment variables and labels. Specifically, it connects to Authentik and Crowdsec services.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
.kuma monitors from kuma.* labels>
```bash ```bash
docker stack services gatus docker stack services gatus
docker service logs -f gatus docker service logs -f gatus
``` ```
### Backups ### Backups
Critical backups of /DockerVol/gatus/data are required for reconstructing the service. Critical data is stored on a persistent volume at /DockerVol/gatus/data. Regular backups should be performed to ensure data integrity.
### Restore ### Restore
To restore the service, re-run the deploy script:
```bash ```bash
cd services/swarm/stack/gatus
./deploy.sh ./deploy.sh
``` ```
--- ---
## Common Failures ## Common Failures
| Failure | Symptom | Cause | Fix | | Symptom | Cause | Fix |
- **Service not running**: Service does not appear in the dashboard. |- **Service not available**: Insufficient CPU or memory resources |
- Symptom: `gatus` is not listed in the dashboard. |- **Network issues**: Verify Caddy configuration and network connectivity |
- Cause: gatus service is not deployed or is down.
- Fix: Check deployment status and restart the service if necessary.
| 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.
--- ---
@ -112,15 +106,18 @@ cd services/swarm/stack/gatus
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-21 | 90f111b6 | Initial deployment of gatus stack. | | 2026-04-22 | 0b4d0d85 | Initial documentation creation |
| 2026-04-21 | c6ba6d93 | Updated environment variables for better security. | | 2026-04-21 | 90f111b6 | Minor bug fixes and improvements |
| 2026-04-21 | 3d8a5197 | Fixed service port conflict with other services. | | 2026-04-21 | c6ba6d93 | Added support for multiple Docker Swarm networks |
| 2026-04-21 | 3d8a5197 | Improved logging and monitoring |
<The initial version of the gatus stack was deployed on April 21, 2026. The following commits updated the service configuration to improve security and fixed a service port conflict.> <Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
The gatus stack has undergone significant changes since its initial creation. The most recent updates have focused on improving stability and adding support for multiple Docker Swarm networks. Minor bug fixes and enhancements have been made to ensure a seamless user experience.
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-22T00:43:36.946Z - Generated by Gremlin on 2026-04-22T19:54:10.748Z
- Source: swarm/gatus.yaml - Source: swarm/gatus.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections