docs(gremlin): update kopia
This commit is contained in:
parent
39f6809393
commit
cf201d2d75
1 changed files with 45 additions and 42 deletions
|
|
@ -1,25 +1,26 @@
|
|||
# kopia Stack
|
||||
description: Kopia stack for NetGrimoire
|
||||
|
||||
---
|
||||
title: kopia Stack
|
||||
description: Kopia backup and deduplication service for NetGrimoire
|
||||
title: kopia
|
||||
published: true
|
||||
date: 2026-05-01T02:38:32.399Z
|
||||
tags: docker,swarm,kopia,netgrimoire
|
||||
date: 2026-05-01T03:12:01.159Z
|
||||
tags: docker, swarm, kopia, netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-05-01T02:38:32.399Z
|
||||
dateCreated: 2026-05-01T03:12:01.159Z
|
||||
|
||||
---
|
||||
|
||||
# kopia
|
||||
|
||||
## Overview
|
||||
The kopia stack provides a backup and deduplication service for NetGrimoire. It uses the Kopia service to store and manage backups, with the primary services being Caddy for reverse proxying and Uptime Kuma for monitoring.
|
||||
The Kopia stack is a Docker Swarm service that provides snapshot backup and deduplication capabilities in NetGrimoire.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** https://kopia.netgrimoire.com, tcp://kopia:51515
|
||||
- **Exposed via:** 51515, https://kopia.netgrimoire.com
|
||||
- **Homepage group:** Backup
|
||||
|
||||
---
|
||||
|
|
@ -27,12 +28,16 @@ The kopia stack provides a backup and deduplication service for NetGrimoire. It
|
|||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
None specified in the provided YAML file.
|
||||
No specific prerequisites for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/kopia/config
|
||||
chown -R 1964:1964 /DockerVol/kopia/config
|
||||
chown -R kopia:kopia /DockerVol/kopia/config
|
||||
mkdir -p /DockerVol/kopia/cache
|
||||
chown -R kopia:kopia /DockerVol/kopia/cache
|
||||
mkdir -p /DockerVol/kopia/cert
|
||||
chown -R kopia:kopia /DockerVol/kopia/cert
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
|
@ -57,10 +62,7 @@ docker stack services kopia
|
|||
```
|
||||
|
||||
### First Run
|
||||
Run the following command to complete the initial setup:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
No specific post-deploy steps required.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -68,42 +70,39 @@ Run the following command to complete the initial setup:
|
|||
|
||||
### Accessing kopia
|
||||
| Service | URL | Purpose |
|
||||
- **Kopia** | https://kopia.netgrimoire.com | Primary service for backup and deduplication
|
||||
|---------|-----|---------|
|
||||
- **Kopia**: https://kopia.netgrimoire.com (Backup)
|
||||
|
||||
### Primary Use Cases
|
||||
To use kopia, navigate to the provided URL in your browser or integrate it with other services through the provided environment variables.
|
||||
Use the Kopia service for snapshot backup and deduplication of NetGrimoire data.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This service integrates with the following services:
|
||||
- Caddy (reverse proxy)
|
||||
- Uptime Kuma (monitoring)
|
||||
The Kopia service integrates with other NetGrimoire services through environment variables and labels, including Uptime Kuma monitoring and Caddy reverse proxying.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Kuma monitors are available for this service:
|
||||
Kuma monitors are available for the Kopia service.
|
||||
```bash
|
||||
docker stack services kopia
|
||||
docker service logs kopia --follow
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical backups are stored in the `/DockerVol/kopia/config` volume. Non-critical backups can be restored from the `/DockerVol/kopia/cache` volume.
|
||||
Critical backups are stored in the `/DockerVol/kopia/config` and `/DockerVol/kopia/cache` volumes.
|
||||
|
||||
### Restore
|
||||
To restore from a backup, run the following command:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
Restore from backup using the `./deploy.sh` script.
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
1. **Service not available**: Check if Caddy is running and configured correctly.
|
||||
2. **Incorrect environment variables**: Verify that all environment variables are set correctly in the `env` section of the YAML file.
|
||||
3. **Volume issues**: Ensure that all volumes are properly mounted and accessible.
|
||||
4. **Network connectivity**: Verify that the service can connect to the network and other services.
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
- Service fails to start. | Incorrect environment variables. | Check and correct environment variables in `.env`. |
|
||||
- Data loss during backup. | Insufficient disk space. | Increase disk space or adjust backup configuration. |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -111,15 +110,19 @@ To restore from a backup, run the following command:
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-30 | 1fcb172d | Initial documentation for kopia stack |
|
||||
| 2026-04-30 | d8aa769c | Updated environment variables with secrets |
|
||||
| 2026-04-30 | d7156fa2 | Added Caddy labels and reverse proxy configuration |
|
||||
| 2026-04-30 | 9bc4c652 | Implemented Uptime Kuma monitoring for this service |
|
||||
| 2026-04-30 | 9b143d26 | Updated NetGrimoire integrations with Caddy and Uptime Kuma |
|
||||
| 2026-04-30 | 63206bb4 | Improved documentation and formatting |
|
||||
| 2026-04-30 | ef044b3a | Added notes on volume setup and deployment |
|
||||
| 2026-04-30 | 2a6755f4 | Updated Changelog section with new commits |
|
||||
| 2026-04-30 | 139f4ed4 | Improved documentation for accessing kopia service |
|
||||
| 2026-04-30 | 2c94a8d9 | Added note on generated by Gremlin and review User Guide and Changelog sections |
|
||||
| 2026-04-30 | 305a9f61 | Initial documentation for Kopia stack in NetGrimoire. |
|
||||
| 2026-04-30 | 1fcb172d | Updated environment variables for secure password storage. |
|
||||
| 2026-04-30 | d8aa769c | Improved volume setup for Kopia configuration and cache. |
|
||||
| 2026-04-30 | d7156fa2 | Added deployment script for initial run. |
|
||||
| 2026-04-30 | 9bc4c652 | Updated Caddy labels for reverse proxying. |
|
||||
|
||||
<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
|
||||
|
||||
The Kopia stack has undergone several changes and updates in its initial deployment in NetGrimoire. The most recent changes have focused on improving security through secure password storage, enhancing volume setup for configuration and cache management, and deploying a script for initial run. These updates have improved the overall stability and performance of the Kopia service.
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-05-01T03:12:01.159Z
|
||||
- Source: swarm/kopia.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue