srekit runbook¶

Generate a runbook — the operational playbook on-call reaches for when an alert fires. Sections: Symptoms, Severity & SLO impact, Diagnose, Mitigate, Verify, After the fact, References.

Synopsis¶

srekit runbook --title TITLE [flags]

Flags¶

Flag	Required	Description
`--title`	yes	Runbook subject (often the alert name)
`--service`	no	Service this runbook covers
`--alert`	no	Specific alert name / id

Plus the shared output flags. Default filename: runbook-<slug-of-title>.md.

Examples¶

srekit runbook --title "p99 latency spike" --service api-gw --alert APIGwHighP99 \
  --out runbook-apigw-p99.md

To stdout, no service binding:

srekit runbook --title "DB connection storm" --stdout

Section structure¶

Section headings render bilingually — Russian, with the English term in parentheses. Below they are given by stable id and English term; srekit runbook -T X --json | jq -r '.sections[].title' prints them as they appear in the document.

Front matter: id, creation_date, modification_date, type: runbook, title, service, alert, tags
symptoms — Symptoms: what the alert actually looks like
severity_slo_impact — Severity & SLO impact: how bad this is, and against which budget
diagnose — Diagnose: investigations to run, dashboards to check
mitigate — Mitigate: bounded steps that stop user impact — immediate action, rollback, failover
verify — Verify: how to confirm the mitigation worked
after_the_fact — After the fact: open a postmortem above a given SEV, fold surprises back into this runbook
references — References

Template shape¶

runbook ships as a v1 YAML artifact (internal/tmpl/templates/runbook.yaml) — frontmatter, H1, meta_bullets, sections (symptoms, severity_slo_impact, diagnose, mitigate, verify, after_the_fact, references). Template expressions reference .Meta.<Field> for ID, Title, Service, Alert, Now. See srekit postmortem for the full schema reference.