Runbook 的编写标准
Runbook 的价值是让不同的值班人员执行结果一致：命令、预期输出、异常分支与回滚步骤都写成可以照做的清单。编写标准很朴素——凌晨两点被叫醒的人拿着手册也能安全执行完，不需要临时判断，也不需要凭经验发挥。
基本信息
| 核心章节 | 前置检查、执行步骤、异常分支、回滚、收尾验证 |
|---|---|
| 编写原则 | 每条命令写清预期输出与判断依据 |
| 版本管理 | 入库版本化，改动记录在案 |
| 演练要求 | 季度演练一次，让新人按手册独立执行 |
| 维护方式 | 把踩过的坑补进异常分支 |
| 关联材料 | 变更单、补丁台账与监控告警入口 |
Runbook 章节与内容
| 章节 | 内容 | 要点 |
|---|---|---|
| 前置检查 | 备份可用、监控在线 | 每项都要可验证 |
| 执行步骤 | 命令与预期输出 | 逐条编号，写清判断依据 |
| 异常分支 | 常见报错与处理方式 | 附升级联系人与时限 |
| 回滚 | 包回滚命令、配置回滚路径 | 明确回滚触发条件 |
| 收尾 | 验证清单与台账回填 | 验证不通过不算完成 |
| 版本信息 | 版本号与修订记录 | 与变更单关联 |
Runbook 骨架
Runbook 骨架
# 任务：XX 系统月度安全补丁
## 前置检查
- [ ] 备份任务完成且可用（校验记录）
- [ ] 监控与告警在线
## 执行步骤
1. 命令：dnf update --security -y；预期：完成无报错，记录包列表
2. 命令：dnf needs-restarting -r；预期：按退出码判断是否需要重启
## 异常分支
- 报错 XXX：处理步骤与升级联系人
## 回滚
- 包回滚命令、配置回滚路径、回滚后验证
## 收尾
- [ ] 验证清单完成并回填变更单典型使用场景
- 值班交接与新人上手
- 外包或运维团队接手时的交付物
- 重大补丁的标准化执行
- 演练与复盘的基础材料
- 减少对个别骨干的经验依赖
- 审计时证明操作有据可依
好的 Runbook 让凌晨被叫醒的人也能安全执行。写的标准是照做即可，不需要读者在窗口里临时判断。
手册与实际命令脱节时，值班只能凭经验发挥，规范与操作成了两张皮。出问题时既无法复现，也难以界定责任。