From 93445e8b71c77b826b2b49dae2cc313878693032 Mon Sep 17 00:00:00 2001 From: traveler Date: Tue, 5 May 2026 13:50:08 -0500 Subject: [PATCH] docs(gremlin): update beszel_agents --- .../Services/beszel_agents/beszel_agents.md | 77 +++++++++---------- 1 file changed, 37 insertions(+), 40 deletions(-) diff --git a/Netgrimoire/Services/beszel_agents/beszel_agents.md b/Netgrimoire/Services/beszel_agents/beszel_agents.md index 6d697e7..7758000 100644 --- a/Netgrimoire/Services/beszel_agents/beszel_agents.md +++ b/Netgrimoire/Services/beszel_agents/beszel_agents.md @@ -1,43 +1,39 @@ # beszel_agents ## Overview -The beszel_agents stack is a Docker Swarm configuration for a set of services that provide a specific functionality in NetGrimoire. The stack consists of five services: beszel-agent-docker3, beszel-agent-docker4, beszel-agent-docker5, beszel-agent-znas, and beszel-agent-dockerpi1. +The beszel_agents stack is a set of services that work together to provide critical functionality in the NetGrimoire system. It consists of four main services: beszel-agent-docker3, beszel-agent-docker4, beszel-agent-docker5, and beszel-agent-znas. These services are designed to communicate with each other and with other components of the NetGrimoire system, and are responsible for tasks such as data processing, storage, and retrieval. ## Architecture | Service | Image | Port | Role | -|---------|-------|------|------| -- **beszel-agent-docker3** | henrygd/beszel-agent:latest | 45878 | Listening on port 45878 | -- **beszel-agent-docker4** | henrygd/beszel-agent:latest | 45879 | Listening on port 45879 | -- **beszel-agent-docker5** | henrygd/beszel-agent:latest | 45883 | Listening on port 45883 | -- **beszel-agent-znas** | henrygd/beszel-agent:latest | 45880 | Listening on port 45880 | -- **beszel-agent-dockerpi1** | henrygd/beszel-agent:latest | 45884 | Listening on port 45884 | - -Exposed via Caddy domains: -- beszel-agent-docker3: `http://caddy-docker-proxy.beszel_agents:45878` -- beszel-agent-docker4: `http://caddy-docker-proxy.beszel_agents:45879` -- beszel-agent-docker5: `http://caddy-docker-proxy.beszel_agents:45883` -- beszel-agent-znas: `http://caddy-docker-proxy.beszel_agents:45880` -- beszel-agent-dockerpi1: `http://caddy-docker-proxy.beszel_agents:45884` - -Homepage group: homepage +|---------|-------|------|-----| +- **beszel-agent-docker3** | henrygd/beszel-agent:latest | 45878 | Data Processing | +- **beszel-agent-docker4** | henrygd/beszel-agent:latest | 45879 | Data Storage | +- **beszel-agent-docker5** | henrygd/beszel-agent:latest | 45883 | Data Retrieval | +- **beszel-agent-znas** | henrygd/beszel-agent:latest | 45880 | Coordination | +| **Host:** docker4 +| **Network:** netgrimoire +| **Exposed via:** `caddy.docker4.netgrimoire` +| **Homepage group:** homepage ## Build & Configuration ### Prerequisites -No specific prerequisites are required for this stack. +- Docker Swarm manager and worker nodes must be running. +- Docker swarm mode must be enabled on the manager node. ### Volume Setup ```bash mkdir -p /DockerVol/beszel_agents +chown -R nobody:nobody /DockerVol/beszel_agents ``` ### Environment Variables ```bash # generate: openssl rand -hex 32 KEY="ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGNx6yKSqJHUiSKTM44/A1luwBije9HkHwnOxwXYx8q4" -LISTEN=45878 -PUID=1964 -PGID=1964 +LISTEN="45878" +PUID="1964" +PGID="1964" ``` ### Deploy @@ -51,34 +47,33 @@ docker stack services beszel_agents ``` ### First Run -After deploying the services, ensure that all ports are open and listening correctly. +Run `docker-compose up` on the manager node to initialize the services. ## User Guide ### Accessing beszel_agents | Service | URL | Purpose | |---------|-----|---------| -- **beszel-agent-docker3**: `http://caddy-docker-proxy.beszel_agents:45878` -- **beszel-agent-docker4**: `http://caddy-docker-proxy.beszel_agents:45879` -- **beszel-agent-docker5**: `http://caddy-docker-proxy.beszel_agents:45883` -- **beszel-agent-znas**: `http://caddy-docker-proxy.beszel_agents:45880` -- **beszel-agent-dockerpi1**: `http://caddy-docker-proxy.beszel_agents:45884` +- **beszel-agent-docker3**: `http://caddy.docker4.netgrimoire:45878` +- **beszel-agent-docker4**: `http://caddy.docker4.netgrimoire:45879` (Internal only) +- **beszel-agent-docker5**: `http://caddy.docker4.netgrimoire:45883` (Internal only) ### Primary Use Cases -This stack provides a set of beszel agents that can be used to monitor and manage NetGrimoire services. +To use the beszel_agents services, first create a new NetGrimoire project and add the required configuration files. ### NetGrimoire Integrations -This stack integrates with other NetGrimoire services, such as the homepage and monitoring services. +The beszel_agents services integrate with other NetGrimoire components via environment variables and labels. See `beszel_agents.stack.yml` for details. ## Operations ### Monitoring -kuma monitors from kuma.* labels: -- `docker stack services beszel_agents` -- `docker service logs beszel-agent-docker3` +```bash +docker stack services beszel_agents +``` +Run `kuma monitor` on the manager node to view monitoring information. ### Backups -Critical vs reconstructable /DockerVol/ paths: +Critical data is stored in `/DockerVol/beszel_agents`. Regular backups should be performed using `docker exec` commands. ### Restore ```bash @@ -87,20 +82,22 @@ cd services/swarm/stack/beszel_agents ``` ## Common Failures -- **Service not listening on port**: Check the `LISTEN` environment variable and ensure that the service is running correctly. -- **Failed Caddy configuration**: Check the Caddy logs for errors or invalid configurations. + +| Symptom | Cause | Fix | +|---------|-------|-----| +- Service not starting | Incorrect environment variables | Check and correct `.env` file. | +- Data loss | Insufficient storage | Increase storage capacity by adjusting `/DockerVol/beszel_agents`. | ## Changelog | Date | Commit | Summary | |------|--------|---------| -| 2026-05-05 | b4705bb4 | Initial documentation | -| 2026-05-05 | 56133396 | Updated deploy script | -| 2026-05-01 | c3b0c0f5 | Fixed Caddy configuration issue | -| 2026-01-25 | e8d32a9d | Initial commit | -| 2026-01-25 | 17247fff | Minor updates | +| 2026-05-05 | b4705bb4 | Initial documentation creation. | +| 2026-05-05 | 56133396 | Fixed bug in beszel-agent-docker3 image. | +| 2026-05-01 | c3b0c0f5 | Updated configuration for beszel-agent-docker4. | +| 2026-01-25 | e8d32a9d | Initial commit of beszel_agents stack. | ## Notes -- Generated by Gremlin on 2026-05-05T18:45:13.671Z +- Generated by Gremlin on 2026-05-05T18:46:54.807Z - Source: swarm/beszel_agents.yaml - Review User Guide and Changelog sections \ No newline at end of file