initial commit
Some checks failed
Build and Publish TechDocs / build-and-publish (push) Failing after 1m14s
Some checks failed
Build and Publish TechDocs / build-and-publish (push) Failing after 1m14s
Change-Id: Ia7bbd259893786bfd9076bffb8c9e973288defde
This commit is contained in:
4
docs/runbooks/.pages
Normal file
4
docs/runbooks/.pages
Normal file
@@ -0,0 +1,4 @@
|
||||
title: Runbooks
|
||||
nav:
|
||||
- index.md
|
||||
- ...
|
||||
28
docs/runbooks/index.md
Normal file
28
docs/runbooks/index.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Runbooks
|
||||
|
||||
Operational runbooks for **test-ms-c6**.
|
||||
|
||||
Each runbook documents a specific procedure — incident response, rollback steps, scaling operations, or routine maintenance — so that on-call engineers can resolve issues safely and quickly without deep system knowledge.
|
||||
|
||||
## How to use these runbooks
|
||||
|
||||
1. **Identify the scenario** — check the index below or use the search bar at the top of the page.
|
||||
2. **Follow each step exactly** — runbooks are written to be safe to execute under pressure.
|
||||
3. **Record deviations** — if you had to improvise, open a pull request to update the runbook so the next engineer benefits.
|
||||
|
||||
## Index
|
||||
|
||||
| Runbook | Trigger / Alert | Severity |
|
||||
|---------|-----------------|----------|
|
||||
| *(add runbooks below)* | | |
|
||||
|
||||
## Creating a new runbook
|
||||
|
||||
Add a file `docs/runbooks/<scenario-name>.md` using this structure:
|
||||
|
||||
**Severity:** P1 / P2 / P3
|
||||
**Trigger:** What symptom or alert brings an engineer here
|
||||
**Owner:** Team name
|
||||
**Last tested:** YYYY-MM-DD
|
||||
|
||||
Include the following sections: Prerequisites, Steps (numbered), Verification, Escalation, Post-incident.
|
||||
Reference in New Issue
Block a user