a2cd2416fe
Some checks failed
Build and Publish TechDocs / build-and-publish (push) Failing after 1m4s
Change-Id: I732e7af790c42cbd6fc2c2e754882fef44f90c00
56 lines
1.4 KiB
Markdown
56 lines
1.4 KiB
Markdown
# Runbooks
|
|
|
|
Operational runbooks for **test-argocd-gitops-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 template:
|
|
|
|
```
|
|
# Runbook: <Scenario Name>
|
|
|
|
**Severity:** P1 / P2 / P3
|
|
**Trigger:** <What symptom or alert brings an engineer here>
|
|
**Owner:** <Team name>
|
|
**Last tested:** YYYY-MM-DD
|
|
|
|
---
|
|
|
|
## Prerequisites
|
|
|
|
- Access to ...
|
|
- Permissions for ...
|
|
|
|
## Steps
|
|
|
|
1. Confirm the symptom by checking ...
|
|
2. ...
|
|
3. ...
|
|
|
|
## Verification
|
|
|
|
After completing the steps, verify the issue is resolved by ...
|
|
|
|
## Escalation
|
|
|
|
If this runbook does not resolve the issue within _N_ minutes, escalate to ...
|
|
|
|
## Post-incident
|
|
|
|
Open a post-mortem ticket and link it here.
|
|
```
|