docs(gremlin): create kuma
This commit is contained in:
parent
1e48df1369
commit
9184dd84a9
1 changed files with 113 additions and 0 deletions
113
Netgrimoire/Services/kuma/kuma.md
Normal file
113
Netgrimoire/Services/kuma/kuma.md
Normal file
|
|
@ -0,0 +1,113 @@
|
||||||
|
# kuma
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The kuma stack provides monitoring services in NetGrimoire, utilizing the Uptime Kuma dashboard for service monitoring and Autokuma for automatic service discovery.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
| Service | Image | Port | Role |
|
||||||
|
|---------|-------|------|------|
|
||||||
|
- **Host:** docker4
|
||||||
|
- **Network:** netgrimoire
|
||||||
|
- **Exposed via:** kuma.netgrimoire.com, kuma:3001
|
||||||
|
- **Homepage group:** Monitoring
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Build & Configuration
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
No specific prerequisites are required for this stack.
|
||||||
|
|
||||||
|
### Volume Setup
|
||||||
|
```bash
|
||||||
|
mkdir -p /DockerVol/kuma:/app/data
|
||||||
|
chown -R root:kuma /DockerVol/kuma:/app/data
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deploy
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/kuma
|
||||||
|
set -a && source .env && set +a
|
||||||
|
docker stack config --compose-file kuma-stack.yml > resolved.yml
|
||||||
|
docker stack deploy --compose-file resolved.yml kuma
|
||||||
|
rm resolved.yml
|
||||||
|
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.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## User Guide
|
||||||
|
|
||||||
|
### Accessing kuma
|
||||||
|
| Service | URL | Purpose |
|
||||||
|
|---------|-----|---------|
|
||||||
|
- **Kuma Uptime**: kuma.netgrimoire.com (HTTP) - Service Monitoring
|
||||||
|
|
||||||
|
### Primary Use Cases
|
||||||
|
To use this service, access the kuma dashboard at `kuma.netgrimoire.com` to view monitoring data.
|
||||||
|
|
||||||
|
### NetGrimoire Integrations
|
||||||
|
This service connects to other services in NetGrimoire via the netgrimoire overlay network and utilizes environment variables for discovery.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
|
### Monitoring
|
||||||
|
.kuma monitors from kuma.* labels>
|
||||||
|
```bash
|
||||||
|
docker stack services kuma
|
||||||
|
<docker service logs commands>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Backups
|
||||||
|
Critical data is stored on `/DockerVol/kuma:/app/data` which should be backed up periodically.
|
||||||
|
|
||||||
|
### Restore
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/kuma
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 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. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 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 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
Generated by Gremlin on 2026-04-04T19:15:14.960Z
|
||||||
|
Source: swarm/kuma.yaml
|
||||||
|
Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue