docs(gremlin): update dockpeek
This commit is contained in:
parent
b3d0a0b3d6
commit
9ee8f7790f
1 changed files with 48 additions and 51 deletions
|
|
@ -1,38 +1,29 @@
|
|||
---
|
||||
title: dockpeek Stack
|
||||
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 Stack
|
||||
description: Monitoring service for Docker containers
|
||||
|
||||
# dockpeek
|
||||
|
||||
## Overview
|
||||
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.
|
||||
---
|
||||
# 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
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|- **dockpeek** | dockpeek/dockpeek:latest | 3420 | Monitoring |
|
||||
|
||||
Exposed via:
|
||||
- `caddy-dockpeek.netgrimoire.com`
|
||||
|
||||
Homepage group: "Monitoring"
|
||||
|---------|-------|------|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** dockpeek.netgrimoire.com, Internal only
|
||||
- **Homepage group:** Monitoring
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
# Build & Configuration
|
||||
|
||||
### 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
|
||||
```bash
|
||||
mkdir -p /DockerVol/dockpeek
|
||||
chown -R 1964:1964 /DockerVol/dockpeek
|
||||
chown docker:docker /DockerVol/dockpeek
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
|
@ -53,64 +44,70 @@ docker stack services dockpeek
|
|||
```
|
||||
|
||||
### 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
|
||||
| Service | URL | Purpose |
|
||||
|- **dockpeek** | caddy-dockpeek.netgrimoire.com | Monitoring Dashboard |
|
||||
|---------|-----|---------|
|
||||
- **dockpeek** | http://dockpeek.netgrimoire.com | Monitoring service |
|
||||
|
||||
### 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
|
||||
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
|
||||
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
|
||||
docker service logs dockpeek -f
|
||||
```
|
||||
|
||||
### 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
|
||||
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
|
||||
| Symptom | Cause | Fix |
|
||||
|- **dockpeek service not starting** | Insufficient resources or incorrect deployment configuration. | Check the deployment logs and adjust the configuration as needed. |
|
||||
|- **Monitoring data not updating** | Inconsistent data from upstream services. | Verify that upstream services are providing consistent data and update accordingly. |
|
||||
| 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.
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
# Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|- 2026-04-29 | 2256faaa | Initial deployment of dockpeek stack |
|
||||
|- 2026-01-26 | 7e49e367 | Updated environment variables for better security |
|
||||
|- 2026-01-26 | a0b6663e | Improved logging and monitoring configuration |
|
||||
|- 2026-01-10 | 1a374911 | Initial deployment of dockpeek stack |
|
||||
|
||||
<Write a paragraph summarizing the evolution of this service based on the diffs above.>
|
||||
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.
|
||||
|------|--------|---------|
|
||||
| 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 |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-30T03:20:09.765Z
|
||||
- Source: swarm/dockpeek.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
# Notes
|
||||
Generated by Gremlin on 2026-04-30T03:20:12.980Z
|
||||
Source: swarm/dockpeek.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue