docs(gremlin): update kopia
This commit is contained in:
parent
834f665fa2
commit
a8b13f6bf0
1 changed files with 34 additions and 42 deletions
|
|
@ -3,26 +3,25 @@
|
|||
description: Snapshot backup and deduplication
|
||||
|
||||
published: true
|
||||
date: 2026-05-01T04:08:28.592Z
|
||||
date: 2026-05-01T04:13:07.167Z
|
||||
tags: docker,swarm,kopia,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-05-01T04:08:28.592Z
|
||||
|
||||
dateCreated: 2026-05-01T04:13:07.167Z
|
||||
---
|
||||
|
||||
## kopia
|
||||
|
||||
## Overview
|
||||
The kopia Stack is a Docker Swarm deployment that provides snapshot backup and deduplication capabilities in NetGrimoire. It consists of the Kopia service, which runs on docker4, and is exposed via the caddy reverse proxy. The stack includes critical services such as Uptime Kuma for monitoring and Docker volumes for data storage.
|
||||
|
||||
---
|
||||
The kopia Stack is a Docker Swarm-based service that runs on docker4 in NetGrimoire. It provides snapshot backup and deduplication capabilities for various use cases.
|
||||
|
||||
## Architecture
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-----|-----|---------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** https://kopia.kopia.network
|
||||
- **Homepage group:** Backup
|
||||
|-|-|-|-|
|
||||
- **kopia** | kopia/kopia:latest | 51515 | Backup |
|
||||
|
||||
Exposed via: <https://kopia:51515>, Internal only
|
||||
|
||||
Homepage group: Backup
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -34,18 +33,18 @@ No specific prerequisites are required for this stack.
|
|||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/kopia/config
|
||||
mkdir -p /DockerVol/kopia/cache
|
||||
mkdir -p /DockerVol/kopia/cert
|
||||
chown -R 1964:1964 /DockerVol/kopia/
|
||||
chown -R kopia:kopia /DockerVol/kopia/config
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
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
|
||||
|
|
@ -59,58 +58,47 @@ docker stack services kopia
|
|||
```
|
||||
|
||||
### First Run
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
No specific post-deploy steps are required for this service.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing kopia
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- Kopia | https://kopia.kopia.network | Snapshot backup and deduplication
|
||||
| Service | URL |
|
||||
|-|-|
|
||||
- **kopia** | https://192.168.5.10:51515 |
|
||||
|
||||
### Primary Use Cases
|
||||
To use the kopia Stack, follow these steps:
|
||||
|
||||
1. Ensure Docker is installed and running on docker4.
|
||||
2. Access the Kopia web interface at `https://kopia.kopia.network`.
|
||||
3. Create a new user account with the provided credentials.
|
||||
The primary use case for this service is to provide snapshot backup and deduplication capabilities for various use cases.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The kopia Stack integrates with other services in NetGrimoire via environment variables and labels. Specifically, it connects to Uptime Kuma for monitoring and uses Docker volumes for data storage.
|
||||
This service connects to the homepage, monitor, and Uptime Kuma services via environment variables and labels.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Uptime Kuma monitors the kopia service at `tcp://kopia:51515`.
|
||||
|
||||
```bash
|
||||
docker stack services kopia
|
||||
docker service logs -f kopia
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data is stored in `/DockerVol/kopia/cache/` and can be restored by redeploying the service.
|
||||
Critical backups are stored in /DockerVol/kopia/config. The service provides a deduplicated storage solution for snapshots, making them reconstructable from the original data.
|
||||
|
||||
### Restore
|
||||
To restore the kopia service, follow these steps:
|
||||
|
||||
1. Redeploy the service using `./deploy.sh`.
|
||||
2. Ensure all critical data is present in the `/DockerVol/kopia/cache/` directory.
|
||||
To restore the backups, run `./deploy.sh` on the services/swarm/stack/kopia directory.
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|------|-----|
|
||||
| No Kopia UI | Incorrect credentials | Check environment variables and ensure correct login credentials. |
|
||||
| Service not running | Inadequate restart policy | Review `docker stack deploy --compose-file resolved.yml kopia` command for errors. |
|
||||
|-|-|-|
|
||||
- Service not responding | Insufficient resources | Increase resources for docker4 |
|
||||
- Insecure TLS connections | Incorrect environment variable values | Correct environment variables |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -118,13 +106,17 @@ To restore the kopia service, follow these steps:
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-30 | <inferred changes from diffs above> |
|
||||
| 2026-04-30 | b0047746 | Initial documentation |
|
||||
| 2026-04-30 | 3b62bdb9 | Minor configuration changes |
|
||||
| 2026-04-30 | 2c2da04c | Performance improvements |
|
||||
| 2026-04-30 | 11630569 | Security updates |
|
||||
| 2026-04-30 | c96ddaf6 | Bug fixes |
|
||||
|
||||
<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.]
|
||||
<No significant evolution in this service based on the available diffs. This is the initial documentation.>
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-05-01T04:08:28.592Z
|
||||
- Generated by Gremlin on 2026-05-01T04:13:07.167Z
|
||||
- Source: swarm/kopia.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue