runbook-generator
Runbook Generator 是一个用于从服务名称快速生成运维手册(runbook)骨架的工具,属于 DevOps / 站点可靠性工程领域。它通过命令行生成操作手册初稿,覆盖部署、事故响应、维护和回滚等工作流,并可按需定制。核心能力包括:从 CLI 生成 runbook 骨架;提供启动、停止、健康检查、回滚等标准章节;内置结构化的升级与事故处理占位内容;提供部署和事故预案的参考模板。适用场景包括:服务尚无 runbook 需立即建立基线、团队间 runbook 不一致、值班入职需要标准化运维文档,以及为新服务生成可重复的 runbook 脚手架。使用方式为运行 python3 scripts/runbook_generator.py <service-name>,可加 --owner 和 --output 参数将内容写入指定文件。推荐流程为先生成初始骨架,再填写服务专属命令与 URL,补充验证检查与回滚触发条件,在 staging 环境试运行,最后将 runbook 存入与服务代码相近的版本控制中。需注意的常见问题包括缺少回滚触发条件或回滚命令、步骤缺少预期输出检查、归属与升级联系人过期、runbook 从未在非事故场景测试。最佳实践是保持每条命令可复制粘贴、在关键步骤后加入健康检查、按固定周期评审验证,并在事故和复盘后更新内容。目前关于收费、价格、平台支持等信息暂未提供。