From 5f3aa7d22bf09b8f5cfb64d2371929e86cbaf4cd Mon Sep 17 00:00:00 2001 From: traveler Date: Fri, 1 May 2026 08:10:30 -0500 Subject: [PATCH] docs(gremlin): update vault --- Netgrimoire/Services/vault/vault.md | 70 ++++++++++++++--------------- 1 file changed, 34 insertions(+), 36 deletions(-) diff --git a/Netgrimoire/Services/vault/vault.md b/Netgrimoire/Services/vault/vault.md index 65475ac..bf76bb3 100644 --- a/Netgrimoire/Services/vault/vault.md +++ b/Netgrimoire/Services/vault/vault.md @@ -1,42 +1,42 @@ --- title: vault Stack -description: Kopia-Vault snapshot backup and deduplication +description: Kopia Vault Services in NetGrimoire published: true -date: 2026-05-01T04:21:29.154Z +date: 2026-05-01T13:09:07.428Z tags: docker,swarm,vault,netgrimoire editor: markdown -dateCreated: 2026-05-01T04:21:29.154Z +dateCreated: 2026-05-01T13:09:07.428Z --- # vault ## Overview -The `vault` stack is a Docker Swarm-based service that runs Kopia-Vault, a snapshot backup and deduplication solution. It provides a secure way to store and manage backups, ensuring data integrity and availability. +The `vault` stack in NetGrimoire provides a secure Kopia Vault service for snapshot backup and deduplication. This stack consists of the `vault` Docker service, which is configured to run on `znas`. ## Architecture - | Service | Image | Port | Role | -|---------|-------|-----|------| -- **Host:** docker4 -- **Network:** netgrimoire -- **Exposed via:** https://kopia:51516 -- **Homepage group:** Backup +|---------|-------|------|------| +| Host | docker4 | | NetGrimoire Node | +| Network | netgrimoire | | Internal | ---- +Exposed via: , `tcp://kopia:51516` + +Homepage group: Backup ## Build & Configuration - ### Prerequisites -None specified. +You need Docker installed on your system to use this stack. ### Volume Setup ```bash mkdir -p /DockerVol/vault/config -chown -R vault:vault /DockerVol/vault/config +mkdir -p /DockerVol/vault/cache +mkdir -p /DockerVol/vault/cert ``` ### Environment Variables ```bash +# generate: openssl rand -hex 32 PUID=1964 PGID=1964 TZ=America/Chicago @@ -56,35 +56,33 @@ docker stack services vault ``` ### First Run -Run the `./deploy.sh` script after deployment. - ---- +Run `./deploy.sh` after initial deployment for the first time. ## User Guide ### Accessing vault | Service | URL | Purpose | |---------|-----|---------| -- **Kopia-Vault** | https://kopia:51516 | Snapshot backup and deduplication | +- **Host:** +- **Internal only:** ### Primary Use Cases -Use this service to store and manage backups for critical data. +This stack provides a secure Kopia Vault service for snapshot backup and deduplication. ### NetGrimoire Integrations -This stack integrates with other services through environment variables and labels, including Caddy, Uptime Kuma, and Homepage. +This stack connects to other services via the `netgrimoire` network, using environment variables like `KOPIA_SERVER_USERNAME` and `KOPIA_SERVER_PASSWORD`. --- ## Operations ### Monitoring -```bash -docker stack services vault -docker service logs vault -``` +| Monitor Name | Monitor URL | +|-|-| +- **Kuma**: ### Backups -Critical backups are stored in `/DockerVol/vault/config` and are reconstructable from the server's logs. +Critical data is stored in `/DockerVol/vault/cache`. All data can be reconstructed from backups stored in `/DockerVol/vault/backup/repository`. ### Restore ```bash @@ -95,14 +93,10 @@ cd services/swarm/stack/vault --- ## Common Failures - -| Symptom | Cause | Fix | -|---------|------|-----| -| | | | -| | | | -| | | | -| | | | -| | | | +| Failure | Symptom | Cause | Fix | +|-|-|-|-| +- **No connection to Kopia Vault** | No response from vault service. | The vault service is not running. | `docker stack services vault` and inspect logs for issues. +- **Kopia server credentials missing**: Error accessing vault due to invalid credentials. | The Kopia server username or password is incorrect or absent in the environment variables. | Double check that `KOPIA_SERVER_USERNAME` and `KOPIA_SERVER_PASSWORD` are set correctly. --- @@ -110,13 +104,17 @@ cd services/swarm/stack/vault | Date | Commit | Summary | |------|--------|---------| -- No available diffs for this stack. +| 2026-04-30 | 6f7c6f87 | | +| 2026-04-30 | 72833207 | | +| 2026-02-22 | 573a7d8f | | +| 2026-02-13 | 7b2ad934 | | +| 2026-02-13 | 9209aa98 | | - +This is the initial documentation for the `vault` stack in NetGrimoire. --- ## Notes -- Generated by Gremlin on 2026-05-01T04:21:29.154Z +- Generated by Gremlin on 2026-05-01T13:09:07.428Z - Source: swarm/vault.yaml - Review User Guide and Changelog sections \ No newline at end of file