docs(gremlin): update kuma
This commit is contained in:
parent
b49009ca99
commit
f9a8b68fdb
1 changed files with 33 additions and 52 deletions
|
|
@ -1,40 +1,34 @@
|
|||
# kuma Stack
|
||||
|
||||
description: Service Monitor for NetGrimoire
|
||||
|
||||
---
|
||||
# kuma
|
||||
|
||||
## Overview
|
||||
The kuma stack provides a service monitoring solution for NetGrimoire, featuring the uptime-kuma service. This stack monitors services' health and performance.
|
||||
The kuma Stack is a monitoring service in NetGrimoire that provides real-time monitoring of services and infrastructure. The stack consists of two main services: kuma, which is the core monitoring service, and autokuma, which automates the process of adding new services to the monitor.
|
||||
|
||||
## Architecture
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|-------|
|
||||
|---------|-------|------|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- Exposed via: kuma.netgrimoire.com
|
||||
- Homepage group: Monitoring
|
||||
- **Exposed via:** kuma.netgrimoire.com, uptime-kuma.netgrimoire.com
|
||||
- **Homepage group:** Monitoring
|
||||
|
||||
---
|
||||
# Build & Configuration
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
No specific prerequisites for this stack.
|
||||
This stack requires Docker Swarm to be configured and the `docker.stack` command to be available.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/kuma
|
||||
chown -R 1964:1964 /DockerVol/kuma
|
||||
chown -R user:kuma /DockerVol/kuma
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
AUTOKUMA__KUMA__URL=http://kuma:3001
|
||||
# generate: openssl rand -hex 32
|
||||
AUTOKUMA__KUMA__URL=https://kuma:3001
|
||||
AUTOKUMA__KUMA__USERNAME=traveler
|
||||
AUTOKUMA__KUMA__PASSWORD=F@lcon12
|
||||
AUTOKUMA__TAG_NAME=AutoKuma
|
||||
AUTOKUMA__DOCKER__SOURCE="local"
|
||||
```
|
||||
|
||||
### Deploy
|
||||
|
|
@ -48,67 +42,54 @@ docker stack services kuma
|
|||
```
|
||||
|
||||
### First Run
|
||||
Run the following command to complete any pending setup:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
After the first deployment, you need to run `./deploy.sh` to complete the setup.
|
||||
|
||||
---
|
||||
# User Guide
|
||||
## User Guide
|
||||
|
||||
### Accessing kuma
|
||||
| Service | URL |
|
||||
|---------|-----|
|
||||
- **Service Status**: https://kuma.netgrimoire.com
|
||||
- **Kuma Admin**: http://caddy.netgrimoire.com
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **kuma**: https://kuma.netgrimoire.com (Monitor)
|
||||
- **uptime-kuma**: https://kuma.netgrimoire.com (Dashboard)
|
||||
|
||||
### Primary Use Cases
|
||||
To access the service status and monitor your services, use the following URLs.
|
||||
This stack provides real-time monitoring of services and infrastructure. It can be used to monitor individual services or the entire NetGrimoire environment.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This stack connects to other services in NetGrimoire through environment variables.
|
||||
The kuma Stack connects to other services in NetGrimoire, such as Caddy for reverse proxying and Uptime Kuma for monitoring.
|
||||
|
||||
---
|
||||
# Operations
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
```bash
|
||||
docker stack services kuma
|
||||
docker logs -f $(docker ps --format 'json' | jq -r '.[]|@base64|base64 --decode')
|
||||
docker service logs -f kuma
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data should be stored on a separate volume. If the primary /DockerVol/kuma is critical, consider enabling backups.
|
||||
Critical data should be backed up regularly. The `/DockerVol/kuma` volume is recommended for storing backups.
|
||||
|
||||
### Restore
|
||||
To restore the kuma stack, run:
|
||||
```bash
|
||||
cd services/swarm/stack/kuma
|
||||
./deploy.sh
|
||||
```
|
||||
If the stack needs to be restored, you can run `./deploy.sh` after deleting the existing `resolved.yml` file.
|
||||
|
||||
---
|
||||
# Common Failures
|
||||
## Common Failures
|
||||
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
| 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 |
|
||||
- Stack does not deploy | Missing dependencies | Run `docker-compose up -d` and wait for it to complete. |
|
||||
- Monitoring not working | Inactive kuma service | Check the status of the kuma service with `docker stack services kuma`. Restart the service if necessary. |
|
||||
|
||||
---
|
||||
# Changelog
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 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 |
|
||||
| 2026-04-06 | 3f791e83 | Initial deployment |
|
||||
| 2026-04-04 | 5b03dbf9 | Update to use Caddy reverse proxying |
|
||||
| 2026-04-04 | 6f0000c4 | Add autokuma service for automated monitoring |
|
||||
| 2026-03-30 | e58b778a | Initial deployment |
|
||||
| 2026-03-30 | 6f369592 | Update to use Docker Swarm stack configuration |
|
||||
|
||||
---
|
||||
# Notes
|
||||
Generated by Gremlin on 2026-04-04T19:17:10.183Z
|
||||
## Notes
|
||||
Generated by Gremlin on 2026-04-07T03:20:50.864Z.
|
||||
Source: swarm/kuma.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue