Add incident-response runbooks, SEV1/SEV2 runbooks, and postmortem template#4
Open
bdevierno1 wants to merge 1 commit into
Open
Add incident-response runbooks, SEV1/SEV2 runbooks, and postmortem template#4bdevierno1 wants to merge 1 commit into
bdevierno1 wants to merge 1 commit into
Conversation
…mplate - docs/runbooks/tier0/: documented + tested rollback paths for all four Tier-0 services (API server, agent runner, database, frontend) — each includes decision gate, artifact identification, step-by-step rollback commands, verification smoke tests, and a test log table. - docs/runbooks/sev1-runbook.md: full SEV1 response procedure (ack <5 min, mitigate <30 min) with assess commands and rollback dispatch table. - docs/runbooks/sev2-runbook.md: SEV2 response procedure (ack <15 min) with per-symptom diagnosis steps. - docs/runbooks/alert-definitions.md: seven named alerts (A01–A07) mapping signal → threshold → severity → runbook link; Prometheus annotation example included. - docs/postmortem-template.md: blameless postmortem template covering summary, timeline, root cause, contributing factors, what went well/wrong, where we got lucky, action items, and detection gap analysis. - docs/postmortems/: empty directory seeded with .gitkeep to hold future filed postmortems. Co-Authored-By: Vecna <noreply@vecna.ai>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/runbooks/tier0/) — one per service (API server, agent runner, database, frontend). Each includes: decision gate (when to roll back), artifact identification, step-by-step rollback commands, verification smoke tests, and a test-log table for drill tracking.docs/runbooks/sev1-runbook.md,sev2-runbook.md) — five-step response procedures (acknowledge → assess → contain → communicate → resolve) with SLA targets and rollback dispatch tables linking to the Tier-0 runbooks above.docs/runbooks/alert-definitions.md) — seven named alerts (A01–A07) mapping signal/threshold/severity to runbook URLs; Prometheus annotation example included so each alert can carryrunbook_urlpointing here.docs/postmortem-template.md) +docs/postmortems/directory — covers summary, timeline, root cause, contributing factors, what went well/wrong, where we got lucky, action items with owners, and detection gap analysis.Why
The release-readiness checklist (
rollback path requirement) and the incident-severity-and-response runbook both require that every Tier-0 service has a documented, testable rollback path and that SEV1/SEV2 alerts link to runbooks. Neither existed before this PR.How to verify
sev1-runbook.mdandsev2-runbook.md; they should resolve to the correcttier0/files.tier0/*.md§4 Verify section againsthttp://127.0.0.1:8000withuvicornrunning.docs/postmortem-template.mdin the GitHub UI; all table columns and code blocks should render cleanly.alert-definitions.mdreferences a real endpoint (/health,/api/health/deep, etc.) that exists inbackend/app/main.py.Rollback
This PR adds documentation only — no code changes. It is safe to revert the entire branch with
git revert --no-commit HEADif the runbook structure needs to change.Out of scope
🤖 Generated with Vecna
Co-Authored-By: Vecna noreply@vecna.ai