Back to Details

runbook-generator

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Runbook Generator

运行手册生成器

Tier: POWERFUL
Category: Engineering
Domain: DevOps / Site Reliability Engineering
层级： POWERFUL
分类： 工程
领域： DevOps / 站点可靠性工程（Site Reliability Engineering）

Overview

概述

Generate operational runbooks quickly from a service name, then customize for deployment, incident response, maintenance, and rollback workflows.
通过服务名称快速生成运维运行手册，然后针对部署、事件响应、维护和回滚工作流进行自定义。

Core Capabilities

核心功能

  • Runbook skeleton generation from a CLI
  • Standard sections for start/stop/health/rollback
  • Structured escalation and incident handling placeholders
  • Reference templates for deployment and incident playbooks
  • 从CLI生成运行手册框架
  • 包含启动/停止/健康检查/回滚的标准章节
  • 结构化的升级和事件处理占位符
  • 部署和事件剧本的参考模板

When to Use

使用场景

  • A service has no runbook and needs a baseline immediately
  • Existing runbooks are inconsistent across teams
  • On-call onboarding requires standardized operations docs
  • You need repeatable runbook scaffolding for new services
  • 某个服务没有运行手册，需要立即建立基准文档
  • 现有运行手册在各团队间不一致
  • 值班人员入职需要标准化的运维文档
  • 需要为新服务生成可重复使用的运行手册框架

Quick Start

快速开始

bash
undefined
bash
undefined

Print runbook to stdout

Print runbook to stdout

python3 scripts/runbook_generator.py payments-api
python3 scripts/runbook_generator.py payments-api

Write runbook file

Write runbook file

python3 scripts/runbook_generator.py payments-api --owner platform --output docs/runbooks/payments-api.md

---
python3 scripts/runbook_generator.py payments-api --owner platform --output docs/runbooks/payments-api.md

---

Recommended Workflow

推荐工作流

  1. Generate the initial skeleton with 
    scripts/runbook_generator.py
    .
  2. Fill in service-specific commands and URLs.
  3. Add verification checks and rollback triggers.
  4. Dry-run in staging.
  5. Store runbook in version control near service code.
  1. 使用
    scripts/runbook_generator.py
    生成初始框架。
  2. 填写服务特定的命令和URL。
  3. 添加验证检查和回滚触发条件。
  4. 在预发布环境中进行试运行。
  5. 将运行手册存储在服务代码附近的版本控制系统中。

Reference Docs

参考文档

  • references/runbook-templates.md
  • references/runbook-templates.md

Common Pitfalls

常见陷阱

  • Missing rollback triggers or rollback commands
  • Steps without expected output checks
  • Stale ownership/escalation contacts
  • Runbooks never tested outside of incidents
  • 缺少回滚触发条件或回滚命令
  • 步骤中没有预期输出检查
  • 所有权/升级联系人信息过时
  • 运行手册从未在事件之外进行测试

Best Practices

最佳实践

  1. Keep every command copy-pasteable.
  2. Include health checks after every critical step.
  3. Validate runbooks on a fixed review cadence.
  4. Update runbook content after incidents and postmortems.
  1. 确保每个命令都可直接复制粘贴使用。
  2. 在每个关键步骤后包含健康检查。
  3. 按固定周期审核验证运行手册。
  4. 在事件发生和事后复盘后更新运行手册内容。