Files
vps/runbooks/README.md
T
windyboy 2d95f87897 docs(runbooks): pgdb ops runbooks — health / restore / update + facts refresh (W1N-228)
- runbooks/pgdb-health.md: read-only health check (8 diagnostics) — containers,
  PG core + HA clients, write activity, TimescaleDB hypertables/compression,
  pgweb auth/bookmarks, daily custom-format backups, disk/fstab, logs
- runbooks/pgdb-restore.md: procedure-type restore (pg_restore -Fc, temp-DB swap,
  approval gates, rollback) — precondition command verified live
- runbooks/pgdb-update.md: gated command reference (pull -> config -q -> up -> verify;
  rollback = /opt/database/run + old volumes)
- index + validate-repo.sh classification updated; hosts/pgdb.md refreshed
  (SSH key auth works, scribe events hypertable, runbook cross-refs)
2026-08-29 14:51:20 +08:00

2.5 KiB

Runbook index

Entry point for all runbooks. Before operational work, read the repo entry AGENTS.md and the spec RUNBOOKS.md. New runbooks start from _template.md.

Route by intent

Intent Runbook Type
mailcow health check mailcow-health.md read-only
mailcow update mailcow-update.md change (gated)
mailcow SMTP/IMAP client mailcow-smtp-client.md reference
Vaultwarden health check vaultwarden-health.md read-only
Vaultwarden SQLite→PG migrate vaultwarden-sqlite-to-postgres.md change (destructive)
PowerDNS health check pdns-health.md read-only
RustDesk health check rustdesk-health.md read-only
Matrix health check matrix-health.md read-only
pgdb health check pgdb-health.md read-only
pgdb DB restore (pg_restore) pgdb-restore.md change (procedure)
pgdb image/compose update pgdb-update.md change (gated)
AdGuard Home health check adguard-home-health.md read-only
Matter packet capture matter-packet-capture.md read-only
Home Assistant maintenance home-assistant-maintenance.md change (gated)
matrix_e2ee integration update matrix-e2ee-update.md change (gated)
Routine Ansible operations ansible-operations.md change (allowlisted)
Linear issue → mergeable change issue-to-merge.md delivery
Failing health/playbook run fix-ci.md change
Release a reviewed change to production release.md change (gated)
Roll back a change rollback.md change (gated)
Controlled network configuration network-change.md change (gated)
Network outage / service recovery network-recovery.md recovery

Notes

  • fix-ci.md, release.md, rollback.md, network-change.md, network-recovery.md are adapted from the upstream guide to this repo's VPS-ops context (execution layer is Ansible + SSH + Linear, not a software CI/CD pipeline).
  • Health runbooks are read-only; they stop (STOP) when live state conflicts with the expected state instead of mutating production.