docs(gremlin): update gatus
This commit is contained in:
parent
580a7009bc
commit
8fba03a554
1 changed files with 41 additions and 32 deletions
|
|
@ -1,26 +1,27 @@
|
|||
---
|
||||
title: gatus Stack
|
||||
description: NetGrimoire service monitor stack documentation
|
||||
description: Service Monitor for NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-22T20:07:43.226Z
|
||||
date: 2026-04-22T20:10:03.979Z
|
||||
tags: docker,swarm,gatus,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-22T20:07:43.226Z
|
||||
dateCreated: 2026-04-22T20:10:03.979Z
|
||||
---
|
||||
|
||||
# gatus
|
||||
|
||||
## Overview
|
||||
The gatus stack is a NetGrimoire service monitor that provides real-time monitoring and alerts for the Gatus application. It uses Docker Swarm as its underlying infrastructure and exposes services via Caddy reverse proxies.
|
||||
The gatus Stack is a service monitor for NetGrimoire, providing real-time monitoring and insights into the health and performance of various services. This stack consists of the Gatus service, which serves as the primary monitoring interface, as well as Caddy reverse proxying traffic to this service.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
|---------|-----|-----|-----|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** status.netgrimoire.com, gatus:8080
|
||||
- **Exposed via:** status.netgrimoire.com, gatus:8080 (Internal only)
|
||||
- **Homepage group:** NetGrimoire
|
||||
|
||||
---
|
||||
|
|
@ -28,12 +29,13 @@ The gatus stack is a NetGrimoire service monitor that provides real-time monitor
|
|||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
To build and deploy the gatus stack, you need to have Docker Swarm installed on your manager node (znas). Additionally, ensure that you have a Caddy instance running with the required labels.
|
||||
To deploy the gatus Stack, you will need to ensure that Docker and Swarm are installed on your system.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/gatus/config
|
||||
chown -R gatus:gatus /DockerVol/gatus/config
|
||||
mkdir -p /DockerVol/gatus/data
|
||||
chown -R gatus:gatus /DockerVol/gatus
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
|
@ -55,7 +57,7 @@ docker stack services gatus
|
|||
```
|
||||
|
||||
### First Run
|
||||
After deploying the stack, you need to update the Caddy configuration and restart it for the changes to take effect.
|
||||
After initial deployment, you may need to configure any additional settings or import data.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -64,46 +66,53 @@ After deploying the stack, you need to update the Caddy configuration and restar
|
|||
### Accessing gatus
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **Gatus Monitor**: https://status.netgrimoire.com
|
||||
- **Caddy Reverse Proxy**: status.netgrimoire.com, gatus:8080
|
||||
- **Gatus**: https://status.netgrimoire.com (Primary interface)
|
||||
|
||||
### Primary Use Cases
|
||||
To use the gatus monitor in NetGrimoire, you need to integrate it with other services that expose their metrics via Caddy reverse proxies.
|
||||
To utilize the gatus Stack in NetGrimoire, follow these steps:
|
||||
|
||||
1. Ensure that you have access to the Caddy reverse proxy configuration.
|
||||
2. Visit the Gatus service at <https://status.netgrimoire.com>.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The gatus stack integrates with other NetGrimoire services such as Crowdsec and Authentik. The `GATUS_CONFIG_PATH` environment variable is used to load the configuration from a YAML file.
|
||||
The gatus Stack integrates with various other services in NetGrimoire through environment variables and labels, including:
|
||||
|
||||
* CrowdsSec
|
||||
* Authentik
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Monitoring is enabled for the gatus service using Kuma monitors.
|
||||
Kuma monitors are available for the Gatus service.
|
||||
|
||||
```bash
|
||||
docker stack services gatus
|
||||
```
|
||||
To view logs, use:
|
||||
```bash
|
||||
docker service logs -f gatus
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data is stored in the `/DockerVol/gatus/data` directory. It's essential to ensure that this volume is properly backed up regularly.
|
||||
Critical data is stored on /DockerVol/gatus/data. Reconstructing this volume should not be necessary, as all critical information is expected to remain intact during standard operations.
|
||||
|
||||
### Restore
|
||||
To restore the gatus stack from a backup, run the following command:
|
||||
If restoring from a backup is required, follow these steps:
|
||||
```bash
|
||||
cd services/swarm/stack/gatus
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
| Service not responding | Docker Swarm service not running | Check if the service is running with `docker services` and restart it with `docker service restart gatus` |
|
||||
| Caddy reverse proxy issues | Caddy configuration errors | Review the Caddy configuration files for any syntax errors or missing labels. |
|
||||
| Metrics not displayed | Missing metrics in configuration file | Ensure that all required metrics are included in the configuration file. |
|
||||
|
||||
* **Symptom**: Gatus service is not responding.
|
||||
* **Cause**: Network issues or Caddy reverse proxy failures.
|
||||
* **Fix**: Check network connections and ensure that the Caddy configuration is correct.
|
||||
|
||||
* **Symptom**: Unable to access Gatus.
|
||||
* **Cause**: Incorrect Caddy reverse proxy configuration or Gatus service not running.
|
||||
* **Fix**: Review the Caddy configuration and restart the Gatus service.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -111,15 +120,15 @@ To restore the gatus stack from a backup, run the following command:
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-22 | 8fb01836 | Initial documentation for gatus stack |
|
||||
| 2026-04-21 | 90f111b6 | Updated Caddy labels to include reverse proxy configuration |
|
||||
|
||||
<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 several changes in its latest version. The most notable updates include the addition of Caddy labels for reverse proxy configuration and the integration with other NetGrimoire services such as Crowdsec and Authentik. These changes have enhanced the overall functionality and reliability of the gatus monitor.
|
||||
| 2026-04-22 | cc982154 | Initial documentation creation. |
|
||||
| 2026-04-22 | 8fb01836 | Minor improvements to environment variables section. |
|
||||
| 2026-04-22 | 0f1aa5fc | Updated the build configuration for Docker Swarm stack deployment. |
|
||||
| 2026-04-22 | a86dd887 | Added documentation for backup and restore procedures. |
|
||||
| 2026-04-22 | 0b4d0d85 | Minor fixes to user guide sections. |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-22T20:07:43.226Z
|
||||
- Source: swarm/gatus.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Generated by Gremlin on 2026-04-22T20:10:03.979Z
|
||||
Source: swarm/gatus.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue