From 9257ae63f36600f2058af548b4e977d35badfc22 Mon Sep 17 00:00:00 2001 From: traveler Date: Tue, 5 May 2026 13:48:47 -0500 Subject: [PATCH] docs(gremlin): update beszel_agents --- .../Services/beszel_agents/beszel_agents.md | 75 ++++++++++--------- 1 file changed, 40 insertions(+), 35 deletions(-) diff --git a/Netgrimoire/Services/beszel_agents/beszel_agents.md b/Netgrimoire/Services/beszel_agents/beszel_agents.md index 8f4c7cb..6d697e7 100644 --- a/Netgrimoire/Services/beszel_agents/beszel_agents.md +++ b/Netgrimoire/Services/beszel_agents/beszel_agents.md @@ -1,34 +1,39 @@ # beszel_agents ## Overview -The beszel_agents stack is a collection of services in NetGrimoire that utilize the Beszel-Agent, a tool for automating various tasks on the system. The primary services included in this stack are beszel-agent-docker3, beszel-agent-docker4, beszel-agent-docker5, and beszel-agent-znas. +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. ## Architecture - | Service | Image | Port | Role | |---------|-------|------|------| -- **beszel-agent-docker3** | henrygd/beszel-agent:latest | 45878 | Beszel-Agent | -- **beszel-agent-docker4** | henrygd/beszel-agent:latest | 45879 | Beszel-Agent | -- **beszel-agent-docker5** | henrygd/beszel-agent:latest | 45883 | Beszel-Agent | -- **beszel-agent-znas** | henrygd/beszel-agent:latest | 45880 | Beszel-Agent | -- **Host:** docker4 -- **Network:** netgrimoire -- **Exposed via:** `caddy.beszel_agents.net` (Caddy labels) or Internal only -- **Homepage group:** homepage +- **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 ## Build & Configuration ### Prerequisites -To build and deploy the beszel_agents stack, you need to have Docker installed on your system. +No specific prerequisites are required for this stack. ### Volume Setup ```bash mkdir -p /DockerVol/beszel_agents -chown -R docker4:docker4 /DockerVol/beszel_agents ``` ### Environment Variables ```bash +# generate: openssl rand -hex 32 KEY="ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGNx6yKSqJHUiSKTM44/A1luwBije9HkHwnOxwXYx8q4" LISTEN=45878 PUID=1964 @@ -46,33 +51,34 @@ docker stack services beszel_agents ``` ### First Run -After the initial deployment, you need to wait for 5 seconds and then check the logs of the Beszel-Agent services. +After deploying the services, ensure that all ports are open and listening correctly. ## User Guide ### Accessing beszel_agents | Service | URL | Purpose | -- **beszel-agent-docker3** | `http://caddy.beszel_agents.net` | Beszel-Agent | -- **beszel-agent-docker4** | `http://caddy.beszel_agents.net:45879` | Beszel-Agent | -- **beszel-agent-docker5** | `http://caddy.beszel_agents.net:45883` | Beszel-Agent | -- **beszel-agent-znas** | `http://caddy.beszel_agents.net:45880` | Beszel-Agent | +|---------|-----|---------| +- **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` ### Primary Use Cases -The beszel_agents stack is used for automating tasks on the system, such as monitoring and maintenance. +This stack provides a set of beszel agents that can be used to monitor and manage NetGrimoire services. ### NetGrimoire Integrations -This stack connects to other services in NetGrimoire, such as the homepage dashboard. +This stack integrates with other NetGrimoire services, such as the homepage and monitoring services. ## Operations ### Monitoring -```bash -docker stack services beszel_agents -docker service logs -f beszel-agent-docker3 -``` +kuma monitors from kuma.* labels: +- `docker stack services beszel_agents` +- `docker service logs beszel-agent-docker3` ### Backups -Critical data should be stored on a separate volume, such as `/DockerVol/beszel_agents/critical_data`. +Critical vs reconstructable /DockerVol/ paths: ### Restore ```bash @@ -81,21 +87,20 @@ cd services/swarm/stack/beszel_agents ``` ## Common Failures -| Symptom | Cause | Fix | -- ** Beszel-Agent not starting** | The container is not running. | `docker service start beszel-agent-docker3` | -- ** Beszel-Agent not connecting to the network** | The container's network configuration is incorrect. | `docker run -it --rm henrygd/beszel-agent:latest --net=netgrimoire` | +- **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. ## Changelog | Date | Commit | Summary | |------|--------|---------| -| 2026-05-05 | 56133396 | Initial documentation and deployment of the beszel_agents stack. | -| 2026-05-01 | c3b0c0f5 | Minor adjustments to environment variables and deploy script. | -| 2026-01-25 | e8d32a9d | Initial version of the beszel_agents stack. | -| 2026-01-25 | 17247fff | Fixed an issue with the Beszel-Agent not connecting to the network. | -| 2026-01-10 | 1a374911 | Adjusted logging configuration for the Beszel-Agent services. | +| 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 | ## Notes -Generated by Gremlin on 2026-05-05T18:45:08.741Z -Source: swarm/beszel_agents.yaml -Review User Guide and Changelog sections \ No newline at end of file +- Generated by Gremlin on 2026-05-05T18:45:13.671Z +- Source: swarm/beszel_agents.yaml +- Review User Guide and Changelog sections \ No newline at end of file