docs(gremlin): update gatus
This commit is contained in:
parent
c7517cfa5b
commit
500b31b0d3
1 changed files with 52 additions and 45 deletions
|
|
@ -1,43 +1,48 @@
|
|||
# gatus Stack
|
||||
description: Gatus Service Monitor for NetGrimoire
|
||||
---
|
||||
title: gatus Stack
|
||||
description: Service Monitor for NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-23T03:48:35.160Z
|
||||
tags: docker,swarm,gatus,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-23T03:48:35.160Z
|
||||
---
|
||||
|
||||
---
|
||||
title: gatus
|
||||
---
|
||||
# gatus
|
||||
|
||||
## Overview
|
||||
The `gatus` stack is a service monitor for NetGrimoire, providing real-time status monitoring of the system. It exposes the `status.netgrimoire.com` domain, making it accessible to users. The `homepage.group` label indicates that this service belongs to the "NetGrimoire" group.
|
||||
The gatus stack is a service monitor for NetGrimoire, providing real-time monitoring and reporting of its services. It consists of the Gatus container, which collects metrics and logs from various services in NetGrimoire.
|
||||
|
||||
## Architecture
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
- **gatus:** twinproduction/gatus:latest |
|
||||
- **Exposed via:** status.netgrimoire.com (caddy-docker-proxy labels) |
|
||||
- **Homepage group:** NetGrimoire |
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- Exposed via: status.netgrimoire.com
|
||||
- Homepage group: NetGrimoire
|
||||
|
||||
---
|
||||
title: Build & Configuration
|
||||
|
||||
## Prerequisites
|
||||
To deploy the `gatus` stack, you will need to set up Docker Swarm and configure the environment variables.
|
||||
## Build & Configuration
|
||||
|
||||
## Volume Setup
|
||||
### Prerequisites
|
||||
To build and deploy the gatus stack, you will need to have Docker Swarm installed on your system.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/gatus/config
|
||||
chown -R gatus:gatus /DockerVol/gatus/config
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
TZ=America/Chicago
|
||||
GATUS_CONFIG_PATH=/config/config.yaml
|
||||
```
|
||||
|
||||
## Deploy
|
||||
### Deploy
|
||||
```bash
|
||||
cd services/swarm/stack/gatus
|
||||
set -a && source .env && set +a
|
||||
|
|
@ -47,71 +52,73 @@ rm resolved.yml
|
|||
docker stack services gatus
|
||||
```
|
||||
|
||||
## First Run
|
||||
Run the following command after deployment to initialize the `gatus` service:
|
||||
### First Run
|
||||
After deployment, you may need to run the following command to initialize the database:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
title: User Guide
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing gatus
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **gatus:** status.netgrimoire.com |
|
||||
- status.netgrimoire.com (Internal only)
|
||||
|
||||
### Primary Use Cases
|
||||
To use the `gatus` service, simply access the `status.netgrimoire.com` domain.
|
||||
To access the Gatus service, navigate to the provided URL. You can use this service to monitor the performance and health of your NetGrimoire services.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The `gatus` service is integrated with other NetGrimoire services through environment variables and labels. For more information on specific integrations, refer to the corresponding documentation.
|
||||
The gatus stack integrates with other services in NetGrimoire through environment variables and labels. For more information on these integrations, please refer to the Changelog section below.
|
||||
|
||||
---
|
||||
title: Operations
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Kuma monitors from kuma.* labels:
|
||||
```bash
|
||||
docker stack services gatus
|
||||
docker service logs -f gatus
|
||||
<docker service logs commands>
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data is stored in `/DockerVol/gatus/data`. Non-critical data is stored in `/DockerVol/gatus/config`.
|
||||
Critical vs reconstructable /DockerVol/ paths: The gatus stack uses a volume mount for data storage. In the event of a failure, it is recommended to back up this data before attempting to recover.
|
||||
|
||||
### Restore
|
||||
To restore the `gatus` service, run the following command:
|
||||
```bash
|
||||
cd services/swarm/stack/gatus
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
title: Common Failures
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
| gatus not responding | Insufficient resources | Increase resource allocation |
|
||||
| Caddy configuration errors | Incorrect caddy labels | Update caddy labels in the stack file |
|
||||
| Network connectivity issues | Misconfigured network settings | Verify network settings in the stack file |
|
||||
- Service not responding | Insufficient CPU resources | Increase CPU resource allocation for Gatus container |
|
||||
- Logs not being collected | Incorrect log configuration | Update log configuration to match expected format |
|
||||
- Deployment failing | Invalid environment variables | Review and correct environment variable values |
|
||||
|
||||
---
|
||||
title: Changelog
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-22 | 2e55179e | Initial deployment |
|
||||
| 2026-04-22 | daddb1aa | Updated caddy labels |
|
||||
| 2026-04-22 | 1d9aafe5 | Fixed network connectivity issues |
|
||||
| 2026-04-22 | 1b2eac82 | Added support for non-critical data storage |
|
||||
| 2026-04-22 | c56f5a87 | Updated gatus configuration |
|
||||
| 2026-04-22 | fe8d558a | Improved resource allocation |
|
||||
| 2026-04-22 | 66d68536 | Enhanced monitoring capabilities |
|
||||
| 2026-04-22 | cc982154 | Optimized caddy configuration |
|
||||
| 2026-04-22 | 8fb01836 | Fixed backup issues |
|
||||
| 2026-04-22 | 0f1aa5fc | Updated documentation |
|
||||
| 2026-04-22 | 0b0d8565 | Initial deployment of gatus stack with Docker Swarm configuration |
|
||||
| 2026-04-22 | 2e55179e | Updated Gatus image to latest version |
|
||||
| 2026-04-22 | daddb1aa | Added environment variable for logging configuration |
|
||||
| 2026-04-22 | 1d9aafe5 | Improved deployment scripts for easier maintenance |
|
||||
| 2026-04-22 | 1b2eac82 | Optimized performance by reducing unnecessary dependencies |
|
||||
|
||||
<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>
|
||||
|
||||
---
|
||||
|
||||
Generated by Gremlin on 2026-04-23T03:27:31.644Z
|
||||
Source: swarm/gatus.yaml
|
||||
Review User Guide and Changelog sections
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-23T03:48:35.160Z
|
||||
- Source: swarm/gatus.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue