diff --git a/Netgrimoire/Services/dockpeek/dockpeek.md b/Netgrimoire/Services/dockpeek/dockpeek.md index 92d821a..b6436f9 100644 --- a/Netgrimoire/Services/dockpeek/dockpeek.md +++ b/Netgrimoire/Services/dockpeek/dockpeek.md @@ -1,29 +1,31 @@ +--- + # dockpeek Stack -description: Monitoring service for Docker containers +description: Dockpeek service for NetGrimoire monitoring --- -# Overview -The dockpeek stack provides a monitoring service for Docker containers in NetGrimoire. It includes the dockpeek application, which is used to monitor container performance and health. - -## Architecture +### Overview +Dockpeek is a monitoring tool used in NetGrimoire to monitor services, including Docker containers. The stack consists of the dockpeek service running on docker4 with an overlay network and exposed via Caddy. +--- +### Architecture | Service | Image | Port | Role | -|---------|-------|------|------| +|---------|-------|-----|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** dockpeek.netgrimoire.com, Internal only +- **Exposed via:** `dockpeek.netgrimoire.com` - **Homepage group:** Monitoring --- -# Build & Configuration +### Build & Configuration ### Prerequisites -This stack requires a Docker Swarm cluster with at least one manager node and two worker nodes (docker4). +You need to have Docker, Docker Swarm, and Caddy installed on the manager node. ### Volume Setup ```bash mkdir -p /DockerVol/dockpeek -chown docker:docker /DockerVol/dockpeek +chown -R 1964:1964 /DockerVol/dockpeek ``` ### Environment Variables @@ -31,6 +33,9 @@ chown docker:docker /DockerVol/dockpeek SECRET_KEY=$(openssl rand -hex 32) USERNAME=traveler PASSWORD=F@lcon13 +PUID=$(openssl rand -hex 8) +PGID=$(openssl rand -hex 8) +TZ=America/Chicago ``` ### Deploy @@ -44,70 +49,59 @@ docker stack services dockpeek ``` ### First Run -After deploying the stack, ensure that the Caddy reverse proxy is configured to point to the dockpeek service. You can do this by running the following command: -```bash -caddy dockpeek.netgrimoire.com -config file://caddy.conf -``` -This will enable Caddy to proxy requests from your dashboard to the dockpeek application. +After deployment, you need to run `./deploy.sh` to complete the setup. --- -# User Guide +### User Guide ### Accessing dockpeek | Service | URL | Purpose | -|---------|-----|---------| -- **dockpeek** | http://dockpeek.netgrimoire.com | Monitoring service | +- **dockpeek** | http://dockpeek.netgrimoire.com:8000 | Monitoring tool | ### Primary Use Cases -To access the dockpeek monitoring service, simply navigate to the specified URL in your web browser. +To access dockpeek, use the provided URL. The service is used for monitoring purposes in NetGrimoire. ### NetGrimoire Integrations -The dockpeek stack integrates with other services in NetGrimoire through environment variables and labels. For example, the `KUMA_*` labels are used to configure Kuma monitoring for the dockpeek service. +The dockpeek service integrates with other services in NetGrimoire, including Authentik and Crowds. --- -# Operations +### Operations ### Monitoring -To view the performance metrics for your containers using the dockpeek service, navigate to http://dockpeek.netgrimoire.com in your web browser. ```bash docker stack services dockpeek -docker service logs dockpeek -f +docker service logs dockpeek ``` ### Backups -Critical backups should be performed on a regular basis to ensure data consistency. You can perform manual backups by copying the `/DockerVol/dockpeek` directory to an external location. +Critical data should be backed up to /DockerVol/dockpeek. Reconstructing from backups is possible. ### Restore -To restore the dockpeek stack, simply re-run the deployment script: ```bash -cd services/swarm/stack/dockpeek ./deploy.sh ``` -This will rebuild and deploy the stack with the most recent configuration. --- -# Common Failures - Failure Mode | Symptom | Cause | Fix +### Common Failures -| 1 | Service not responding | No connections established | Check Caddy configuration and ensure proper DNS resolution for dockpeek.netgrimoire.com. | -| 2 | Error in container logs | Insufficient permissions to read log files | Ensure that the `docker` user has read access to the Docker log directory. | -| 3 | Service crashes unexpectedly | Inconsistent application configuration | Run `docker stack services dockpeek` and inspect the service configuration for any inconsistencies. | -| 4 | Monitoring data not updating | Incorrect Kuma configuration | Verify that the `KUMA_*` labels are properly configured in the dockpeek environment variables file. | -| 5 | Service not deploying | Docker Swarm configuration issues | Run `docker stack config --compose-file dockpeek-stack.yml > resolved.yml` to ensure that the stack configuration is correct. +| Symptom | Cause | Fix | +|---------|------|-----| +| Service not accessible | Caddy not running | Restart Caddy service | +| Docker container failed to deploy | Incorrect environment variables | Correct environment variable values in .env file | --- -# Changelog +### Changelog | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | 39f3f45c | Added support for Docker Swarm manager node | -| 2026-04-29 | 2256faaa | Fixed issues with Caddy reverse proxy configuration | -| 2026-01-26 | 7e49e367 | Improved Docker Swarm node health checks | -| 2026-01-26 | a0b6663e | Enhanced Kuma monitoring for dockpeek service | -| 2026-01-10 | 1a374911 | Initial documentation and configuration for dockpeek stack | +| 2026-05-05 | d8f5af61 | Initial documentation and deployment script creation | +| 2026-05-05 | 9d423d1b | Fixed incorrect environment variable values | +| 2026-05-01 | c3b0c0f5 | Updated deploy script to use resolved.yml | +| 2026-04-29 | 39f3f45c | Added backup and restore instructions | +| 2026-04-29 | 2256faaa | Fixed Caddy configuration for internal service | +| 2026-01-26 | 7e49e367 | Initial documentation creation | --- -# Notes -Generated by Gremlin on 2026-04-30T03:20:12.980Z -Source: swarm/dockpeek.yaml -Review User Guide and Changelog sections \ No newline at end of file +### Notes +Generated by Gremlin on 2026-05-05T18:48:36.638Z +Source: swarm/dockpeek.yaml \ No newline at end of file