2026-08-17 15:59:00 +08:00
|
|
|
# Runbook index
|
|
|
|
|
|
|
|
|
|
Entry point for all runbooks. Before operational work, read the repo entry
|
|
|
|
|
[`AGENTS.md`](../AGENTS.md) and the spec [`RUNBOOKS.md`](../RUNBOOKS.md). New
|
|
|
|
|
runbooks start from [`_template.md`](_template.md).
|
|
|
|
|
|
|
|
|
|
## Route by intent
|
|
|
|
|
|
|
|
|
|
| Intent | Runbook | Type |
|
|
|
|
|
|---|---|---|
|
|
|
|
|
| mailcow health check | [mailcow-health.md](mailcow-health.md) | read-only |
|
|
|
|
|
| mailcow update | [mailcow-update.md](mailcow-update.md) | change (gated) |
|
|
|
|
|
| mailcow SMTP/IMAP client | [mailcow-smtp-client.md](mailcow-smtp-client.md) | reference |
|
|
|
|
|
| Vaultwarden health check | [vaultwarden-health.md](vaultwarden-health.md) | read-only |
|
|
|
|
|
| Vaultwarden SQLite→PG migrate | [vaultwarden-sqlite-to-postgres.md](vaultwarden-sqlite-to-postgres.md) | change (destructive) |
|
|
|
|
|
| PowerDNS health check | [pdns-health.md](pdns-health.md) | read-only |
|
|
|
|
|
| RustDesk health check | [rustdesk-health.md](rustdesk-health.md) | read-only |
|
|
|
|
|
| Matrix health check | [matrix-health.md](matrix-health.md) | read-only |
|
|
|
|
|
| AdGuard Home health check | [adguard-home-health.md](adguard-home-health.md) | read-only |
|
2026-08-22 10:14:29 +08:00
|
|
|
| Matter packet capture | [matter-packet-capture.md](matter-packet-capture.md) | read-only |
|
2026-08-17 16:02:33 +08:00
|
|
|
| Home Assistant maintenance | [home-assistant-maintenance.md](home-assistant-maintenance.md) | change (gated) |
|
2026-08-17 15:59:00 +08:00
|
|
|
| Routine Ansible operations | [ansible-operations.md](ansible-operations.md) | change (allowlisted) |
|
|
|
|
|
| Linear issue → mergeable change | [issue-to-merge.md](issue-to-merge.md) | delivery |
|
|
|
|
|
| Failing health/playbook run | [fix-ci.md](fix-ci.md) | change |
|
|
|
|
|
| Release a reviewed change to production | [release.md](release.md) | change (gated) |
|
|
|
|
|
| Roll back a change | [rollback.md](rollback.md) | change (gated) |
|
|
|
|
|
| Controlled network configuration | [network-change.md](network-change.md) | change (gated) |
|
|
|
|
|
| Network outage / service recovery | [network-recovery.md](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.
|
