docs(gremlin): update kopia
This commit is contained in:
parent
f1233ce61c
commit
171d00245c
1 changed files with 40 additions and 37 deletions
|
|
@ -1,49 +1,51 @@
|
|||
---
|
||||
title: kopia Stack
|
||||
description: Kopia snapshot backup and deduplication service
|
||||
description: Kopia snapshot backup and deduplication service in NetGrimoire.
|
||||
published: true
|
||||
date: 2026-04-30T22:47:40.641Z
|
||||
date: 2026-04-30T22:51:02.688Z
|
||||
tags: docker,swarm,kopia,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-30T22:47:40.641Z
|
||||
dateCreated: 2026-04-30T22:51:02.688Z
|
||||
---
|
||||
|
||||
# kopia
|
||||
|
||||
## Overview
|
||||
The kopia stack provides a snapshot backup and deduplication service for NetGrimoire, utilizing Docker Swarm for management.
|
||||
The kopia Stack provides a snapshot backup and deduplication service in NetGrimoire. It consists of the kopia container running on node znas.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** kopia.netgrimoire.com, https://kopia:51515
|
||||
- **Homepage group:** Backup
|
||||
- **kopia:** `kopia/kopia:latest` | 51515 | Backup and Deduplication |
|
||||
|
||||
Exposed via: `kopia.netgrimoire.com`, Internal only
|
||||
|
||||
Homepage group: Backup
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
Ensure Docker Swarm is installed and configured on the manager node (znas) and worker nodes (docker4).
|
||||
No specific prerequisites are required 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
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
# generate: openssl rand -hex 32
|
||||
KOPIA_PASSWORD=F@lcon13
|
||||
KOPIA_SERVER_USERNAME=admin
|
||||
KOPIA_SERVER_PASSWORD=F@lcon13
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
TZ=America/Chicago
|
||||
```
|
||||
|
||||
### Deploy
|
||||
|
|
@ -57,7 +59,7 @@ docker stack services kopia
|
|||
```
|
||||
|
||||
### First Run
|
||||
Post-deploy steps:
|
||||
Run the following command to complete the initial setup:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
|
|
@ -69,43 +71,41 @@ Post-deploy steps:
|
|||
### Accessing kopia
|
||||
| Service | URL |
|
||||
|---------|-----|
|
||||
- **Host:** kopia.netgrimoire.com
|
||||
- **Port:** 51515 (https://kopia:51515)
|
||||
- **kopia:** https://kopia.netgrimoire.com |
|
||||
|
||||
### Primary Use Cases
|
||||
Configure and manage the kopia service in NetGrimoire, including backup and restore operations.
|
||||
To use kopia, navigate to its homepage and follow the instructions.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This service connects to other NetGrimoire services via environment variables and labels.
|
||||
Kopia connects to other services through environment variables and labels.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
| Monitor | URL | Type |
|
||||
|---------|-----|------|
|
||||
- **kuma.monitor.kopia.url** | tcp://kopia:51515 | tcp
|
||||
|
||||
[kuma monitors from kuma.* labels]
|
||||
```bash
|
||||
docker stack services kopia
|
||||
docker service logs -f kopia
|
||||
docker service logs kopia
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical vs reconstructable paths:
|
||||
- `/DockerVol/kopia/config`
|
||||
- `/DockerVol/kopia/cache`
|
||||
- `/data/nfs/znas/Docker/kopia/logs`
|
||||
Critical backups are stored in `/DockerVol/kopia/config` and reconstructed from the `kopia.cache` directory.
|
||||
|
||||
### Restore
|
||||
To restore data, run:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
- kopia service fails to start | Insufficient permissions | Ensure correct ownership and permissions for volumes and environment variables. |
|
||||
- Backup operation fails | Incomplete or missing data | Verify that all required data is present and up-to-date. |
|
||||
- Restored data is incomplete or corrupted | Invalid checksums or incorrect deduplication | Re-run backup operations with corrected checksums or verify the integrity of the restored data. |
|
||||
|---------|------|-----|
|
||||
| Service not reachable | caddy reverse proxy issue | Check caddy logs and restart if necessary |
|
||||
| Data corruption | kopia configuration error | Review configuration files and correct any errors |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -113,12 +113,15 @@ Critical vs reconstructable paths:
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-30 | ef044b3a | Initial documentation creation |
|
||||
| 2026-04-30 | 2a6755f4 | Minor updates and tweaks |
|
||||
| 2026-04-30 | 139f4ed4 | Corrected typo in environment variable generation |
|
||||
| 2026-04-30 | 2c94a8d9 | Updated deploy script for improved security |
|
||||
| 2026-04-30 | 7ef90088 | Added support for TLS certificates |
|
||||
| 2026-04-30 | 63206bb4 | Initial documentation |
|
||||
| 2026-04-30 | ef044b3a | Added environment variables |
|
||||
| 2026-04-30 | 2a6755f4 | Improved volume setup |
|
||||
| 2026-04-30 | 139f4ed4 | Enhanced deploy script |
|
||||
| 2026-04-30 | 2c94a8d9 | Fixed kopia configuration |
|
||||
| 2026-04-07 | d3206f11 | Added logging commands |
|
||||
| 2026-02-11 | aa13ac64 | Improved restore instructions |
|
||||
| 2026-01-30 | 15f5f655 | Initial documentation |
|
||||
|
||||
Generated by Gremlin on 2026-04-30T22:47:40.641Z
|
||||
Generated by Gremlin on 2026-04-30T22:51:02.688Z
|
||||
Source: swarm/kopia.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue