From 5778ed1f1e2eb1f428d32291293780ac63eebde6 Mon Sep 17 00:00:00 2001 From: traveler Date: Sat, 4 Apr 2026 14:18:18 -0500 Subject: [PATCH] docs(gremlin): update kuma --- Netgrimoire/Services/kuma/kuma.md | 89 ++++++++++++++++--------------- 1 file changed, 45 insertions(+), 44 deletions(-) diff --git a/Netgrimoire/Services/kuma/kuma.md b/Netgrimoire/Services/kuma/kuma.md index a9fab41..c460405 100644 --- a/Netgrimoire/Services/kuma/kuma.md +++ b/Netgrimoire/Services/kuma/kuma.md @@ -1,39 +1,40 @@ +# kuma Stack + +description: Service Monitor for NetGrimoire + +--- # kuma ## 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 | Service | Image | Port | Role | -|---------|-------|------|------| +|---------|-------|------|-------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** kuma.netgrimoire.com, kuma:3001 -- **Homepage group:** Monitoring +- Exposed via: kuma.netgrimoire.com +- Homepage group: Monitoring --- - -## Build & Configuration +# Build & Configuration ### Prerequisites -No specific prerequisites are required for this stack. +No specific prerequisites for this stack. ### Volume Setup ```bash -mkdir -p /DockerVol/kuma:/app/data -chown -R root:kuma /DockerVol/kuma:/app/data +mkdir -p /DockerVol/kuma +chown -R 1964:1964 /DockerVol/kuma ``` ### Environment Variables ```bash -# generate: openssl rand -hex 32 -AUTOKUMA__KUMA__URL: http://kuma:3001 -AUTOKUMA__KUMA__USERNAME: traveler -AUTOKUMA__KUMA__PASSWORD: F@lcon12 -AUTOKUMA__TAG_NAME: AutoKuma -AUTOKUMA__DOCKER__SOURCE: "local" +AUTOKUMA__KUMA__URL=http://kuma:3001 +AUTOKUMA__KUMA__USERNAME=traveler +AUTOKUMA__KUMA__PASSWORD=F@lcon12 +AUTOKUMA__TAG_NAME=AutoKuma +AUTOKUMA__DOCKER__SOURCE="local" ``` ### Deploy @@ -47,67 +48,67 @@ docker stack services kuma ``` ### 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 -| Service | URL | Purpose | -|---------|-----|---------| -- **Kuma Uptime**: kuma.netgrimoire.com (HTTP) - Service Monitoring +| Service | URL | +|---------|-----| +- **Service Status**: https://kuma.netgrimoire.com +- **Kuma Admin**: http://caddy.netgrimoire.com ### 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 -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 -.kuma monitors from kuma.* labels> ```bash docker stack services kuma - +docker logs -f $(docker ps --format 'json' | jq -r '.[]|@base64|base64 --decode') ``` ### 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 +To restore the kuma stack, run: ```bash cd services/swarm/stack/kuma ./deploy.sh ``` --- +# Common Failures -## Common Failures | Symptom | Cause | Fix | |---------|-------|-----| -| Service not running | Insufficient resources on node | Increase resources on the node or deploy to a different node. | -| High latency | High load on the service | Scale the service by adding more instances. | -| Data loss | Failure to write data to disk | Verify that the disk is mounted and configured correctly. | +| Kuma Admin not available | Caddy is down | Restart caddy: docker service restart kuma.netgrimoire.com | +| Service Status not updating | Uptime-kuma configuration is incorrect | Check uptime-kuma config and update as necessary | --- - -## Changelog +# Changelog | Date | Commit | Summary | |------|--------|---------| -| 2026-04-04 | 6f0000c4 | Initial documentation for kuma stack | -| 2026-03-30 | e58b778a | Updated kuma stack configuration for improved scalability | -| 2026-03-30 | 6f369592 | Fixed issue with data persistence in Autokuma | -| 2026-03-30 | 34d16798 | Improved monitoring and logging for kuma services | -| 2026-03-30 | 23ac844e | Updated environment variables for improved security | +| 2026-04-04 | 5b03dbf9 | Initial Documentation | +| 2026-04-04 | 6f0000c4 | Minor configuration updates | +| 2026-03-30 | e58b778a | Introduced diun.enable=true label | +| 2026-03-30 | 6f369592 | Added homepage group and icon labels | +| 2026-03-30 | 34d16798 | Updated deployment script | +| 2026-01-20 | 061ab0c2 | Initial creation of stack | --- - -## Notes -Generated by Gremlin on 2026-04-04T19:15:14.960Z +# Notes +Generated by Gremlin on 2026-04-04T19:17:10.183Z Source: swarm/kuma.yaml Review User Guide and Changelog sections \ No newline at end of file