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

docs(gremlin): update kuma

Browse source
This commit is contained in:
traveler 2026-04-04 14:18:18 -05:00
parent 9184dd84a9
commit 5778ed1f1e
1 changed files with 45 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

89
Netgrimoire/Services/kuma/kuma.md
View file

@ -1,39 +1,40 @@
# kuma Stack
description: Service Monitor for NetGrimoire
---
# kuma # kuma
## Overview ## Overview
The kuma stack provides monitoring services in NetGrimoire, utilizing the Uptime Kuma dashboard for service monitoring and Autokuma for automatic service discovery. The kuma stack provides a service monitoring solution for NetGrimoire, featuring the uptime-kuma service. This stack monitors services' health and performance.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|-------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** kuma.netgrimoire.com, kuma:3001 - Exposed via: kuma.netgrimoire.com
- **Homepage group:** Monitoring - Homepage group: Monitoring
--- ---
# Build & Configuration
## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack. No specific prerequisites for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/kuma:/app/data mkdir -p /DockerVol/kuma
chown -R root:kuma /DockerVol/kuma:/app/data chown -R 1964:1964 /DockerVol/kuma
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32 AUTOKUMA__KUMA__URL=http://kuma:3001
AUTOKUMA__KUMA__URL: http://kuma:3001 AUTOKUMA__KUMA__USERNAME=traveler
AUTOKUMA__KUMA__USERNAME: traveler AUTOKUMA__KUMA__PASSWORD=F@lcon12
AUTOKUMA__KUMA__PASSWORD: F@lcon12 AUTOKUMA__TAG_NAME=AutoKuma
AUTOKUMA__TAG_NAME: AutoKuma AUTOKUMA__DOCKER__SOURCE="local"
AUTOKUMA__DOCKER__SOURCE: "local"
``` ```
### Deploy ### Deploy
@ -47,67 +48,67 @@ docker stack services kuma
``` ```
### First Run ### First Run
After deployment, verify that the service is running by executing `docker stack services kuma` and check the logs for any errors. Run the following command to complete any pending setup:
```bash
./deploy.sh
```
--- ---
# User Guide
## User Guide
### Accessing kuma ### Accessing kuma
| Service | URL | Purpose | | Service | URL |
|---------|-----|---------| |---------|-----|
- **Kuma Uptime**: kuma.netgrimoire.com (HTTP) - Service Monitoring - **Service Status**: https://kuma.netgrimoire.com
- **Kuma Admin**: http://caddy.netgrimoire.com
### Primary Use Cases ### Primary Use Cases
To use this service, access the kuma dashboard at `kuma.netgrimoire.com` to view monitoring data. To access the service status and monitor your services, use the following URLs.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to other services in NetGrimoire via the netgrimoire overlay network and utilizes environment variables for discovery. This stack connects to other services in NetGrimoire through environment variables.
--- ---
# Operations
## Operations
### Monitoring ### Monitoring
.kuma monitors from kuma.* labels>
```bash ```bash
docker stack services kuma docker stack services kuma
<docker service logs commands> docker logs -f $(docker ps --format 'json' | jq -r '.[]|@base64|base64 --decode')
``` ```
### Backups ### Backups
Critical data is stored on `/DockerVol/kuma:/app/data` which should be backed up periodically. Critical data should be stored on a separate volume. If the primary /DockerVol/kuma is critical, consider enabling backups.
### Restore ### Restore
To restore the kuma stack, run:
```bash ```bash
cd services/swarm/stack/kuma cd services/swarm/stack/kuma
./deploy.sh ./deploy.sh
``` ```
--- ---
# Common Failures
## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|-------|-----|
| Service not running | Insufficient resources on node | Increase resources on the node or deploy to a different node. | | Kuma Admin not available | Caddy is down | Restart caddy: docker service restart kuma.netgrimoire.com |
| High latency | High load on the service | Scale the service by adding more instances. | | Service Status not updating | Uptime-kuma configuration is incorrect | Check uptime-kuma config and update as necessary |
| Data loss | Failure to write data to disk | Verify that the disk is mounted and configured correctly. |
--- ---
# Changelog
## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-04 | 6f0000c4 | Initial documentation for kuma stack | | 2026-04-04 | 5b03dbf9 | Initial Documentation |
| 2026-03-30 | e58b778a | Updated kuma stack configuration for improved scalability | | 2026-04-04 | 6f0000c4 | Minor configuration updates |
| 2026-03-30 | 6f369592 | Fixed issue with data persistence in Autokuma | | 2026-03-30 | e58b778a | Introduced diun.enable=true label |
| 2026-03-30 | 34d16798 | Improved monitoring and logging for kuma services | | 2026-03-30 | 6f369592 | Added homepage group and icon labels |
| 2026-03-30 | 23ac844e | Updated environment variables for improved security | | 2026-03-30 | 34d16798 | Updated deployment script |
| 2026-01-20 | 061ab0c2 | Initial creation of stack |
--- ---
# Notes
## Notes Generated by Gremlin on 2026-04-04T19:17:10.183Z
Generated by Gremlin on 2026-04-04T19:15:14.960Z
Source: swarm/kuma.yaml Source: swarm/kuma.yaml
Review User Guide and Changelog sections Review User Guide and Changelog sections