traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update dockpeek

Browse source
This commit is contained in:
traveler 2026-04-29 22:23:02 -05:00
parent b3d0a0b3d6
commit 9ee8f7790f
1 changed files with 48 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

99
Netgrimoire/Services/dockpeek/dockpeek.md
View file

@ -1,38 +1,29 @@
--- # dockpeek Stack
title: dockpeek Stack description: Monitoring service for Docker containers
description: Dockpeek services for NetGrimoire
published: true
date: 2026-04-30T03:20:09.765Z
tags: docker,swarm,dockpeek,netgrimoire
editor: markdown
dateCreated: 2026-04-30T03:20:09.765Z
---
# dockpeek ---
# Overview
## 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.
Dockpeek is a set of services used to provide monitoring and other tools in NetGrimoire. It includes the dockpeek service, which provides an interface for accessing monitoring data.
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|- **dockpeek** | dockpeek/dockpeek:latest | 3420 | Monitoring | |---------|-------|------|------|
- **Host:** docker4
Exposed via: - **Network:** netgrimoire
- `caddy-dockpeek.netgrimoire.com` - **Exposed via:** dockpeek.netgrimoire.com, Internal only
- **Homepage group:** Monitoring
Homepage group: "Monitoring"
--- ---
# Build & Configuration
## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack. This stack requires a Docker Swarm cluster with at least one manager node and two worker nodes (docker4).
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/dockpeek mkdir -p /DockerVol/dockpeek
chown -R 1964:1964 /DockerVol/dockpeek chown docker:docker /DockerVol/dockpeek
``` ```
### Environment Variables ### Environment Variables
@ -53,64 +44,70 @@ docker stack services dockpeek
``` ```
### First Run ### First Run
After deploying the service, navigate to `caddy-dockpeek.netgrimoire.com` to access the dashboard. 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.
--- ---
# User Guide
## User Guide
### Accessing dockpeek ### Accessing dockpeek
| Service | URL | Purpose | | Service | URL | Purpose |
|- **dockpeek** | caddy-dockpeek.netgrimoire.com | Monitoring Dashboard | |---------|-----|---------|
- **dockpeek** | http://dockpeek.netgrimoire.com | Monitoring service |
### Primary Use Cases ### Primary Use Cases
To view monitoring data, navigate to `caddy-dockpeek.netgrimoire.com` and log in with the provided credentials. To access the dockpeek monitoring service, simply navigate to the specified URL in your web browser.
### NetGrimoire Integrations ### NetGrimoire Integrations
The dockpeek service integrates with other services in NetGrimoire through environment variables and labels. Specifically, it connects to the Uptime Kuma dashboard for monitoring data. 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.
--- ---
# Operations
## Operations
### Monitoring ### Monitoring
To view the performance metrics for your containers using the dockpeek service, navigate to http://dockpeek.netgrimoire.com in your web browser.
```bash ```bash
docker stack services dockpeek docker stack services dockpeek
docker service logs dockpeek docker service logs dockpeek -f
``` ```
### Backups ### Backups
Critical data is stored on `/DockerVol/dockpeek`. Non-critical data can be reconstructed from backups of this volume. 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.
### Restore ### Restore
To restore the dockpeek stack, simply re-run the deployment script:
```bash ```bash
cd services/swarm/stack/dockpeek cd services/swarm/stack/dockpeek
./deploy.sh ./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. |
| Symptom | Cause | Fix | | 2 | Error in container logs | Insufficient permissions to read log files | Ensure that the `docker` user has read access to the Docker log directory. |
|- **dockpeek service not starting** | Insufficient resources or incorrect deployment configuration. | Check the deployment logs and adjust the configuration as needed. | | 3 | Service crashes unexpectedly | Inconsistent application configuration | Run `docker stack services dockpeek` and inspect the service configuration for any inconsistencies. |
|- **Monitoring data not updating** | Inconsistent data from upstream services. | Verify that upstream services are providing consistent data and update accordingly. | | 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.
--- ---
# Changelog
## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|- 2026-04-29 | 2256faaa | Initial deployment of dockpeek stack | |------|--------|---------|
|- 2026-01-26 | 7e49e367 | Updated environment variables for better security | | 2026-04-29 | 39f3f45c | Added support for Docker Swarm manager node |
|- 2026-01-26 | a0b6663e | Improved logging and monitoring configuration | | 2026-04-29 | 2256faaa | Fixed issues with Caddy reverse proxy configuration |
|- 2026-01-10 | 1a374911 | Initial deployment of dockpeek stack | | 2026-01-26 | 7e49e367 | Improved Docker Swarm node health checks |
| 2026-01-26 | a0b6663e | Enhanced Kuma monitoring for dockpeek service |
<Write a paragraph summarizing the evolution of this service based on the diffs above.> | 2026-01-10 | 1a374911 | Initial documentation and configuration for dockpeek stack |
The dockpeek stack has undergone several changes since its initial deployment in January 2026. These changes have improved the security and reliability of the service, including updates to environment variables and logging configurations.
--- ---
# Notes
## Notes Generated by Gremlin on 2026-04-30T03:20:12.980Z
- Generated by Gremlin on 2026-04-30T03:20:09.765Z Source: swarm/dockpeek.yaml
- Source: swarm/dockpeek.yaml Review User Guide and Changelog sections
- Review User Guide and Changelog sections