docs: rewrite v2 operator documentation

2026-07-31 14:34:34 +02:00
parent bd107d6a30
commit f97daa35d0
2 changed files with 125 additions and 196 deletions
@@ -0,0 +1,42 @@
+# Backup Tool v2 documentation
+
+## Reason for existence
+
+This index points operators and contributors to the authoritative v2.0 procedures. Do not duplicate runbook steps in release evidence or issue comments.
+
+## Start here
+
+- [Project quick start](../README.md)
+- [Upgrade and rollback](runbooks/upgrade.md)
+- [Observability and alert response](runbooks/observability.md)
+- [Disaster recovery](runbooks/disaster-recovery.md)
+
+## Runbooks
+
+| Need | Authoritative guide |
+| --- | --- |
+| Repository lifecycle | [repositories](runbooks/repositories.md) |
+| Metadata protection | [metadata](runbooks/metadata.md) |
+| Master and repository keys | [keys](runbooks/keys.md) |
+| Encrypted recovery bundle | [recovery bundle](runbooks/recovery-bundle.md) |
+| SSH source hardening | [SSH sources](runbooks/ssh-sources.md) |
+| Notification operations | [notifications](runbooks/notifications.md) |
+| Upgrade safety | [upgrade](runbooks/upgrade.md) |
+| Host loss | [disaster recovery](runbooks/disaster-recovery.md) |
+
+## Security boundaries
+
+- [Repository encryption threat model](security/repository-encryption.md)
+- [Notification egress and delivery policy](security/notifications.md)
+- SSH sources require private-key authentication, exact host-key pinning, and a forced-SFTP chrooted account. No password, shell, agent, tunnel, or remote-command mode exists.
+
+## Release records
+
+[Release evidence](release/) records verification rather than replacing runbooks. v2.0 scale certification is documented in `release/m15-evidence.md` and `release/m15-scale-report.json`.
+
+## Verify
+
+```sh
+grep -c '^## ' README.md
+make check
+```