Runbook 要写什么
运维手册（Runbook）是把「出事时该做什么」提前写下来的文档，至少包含拓扑与角色图、常见故障处置步骤、常用命令速查、升级与回滚路径、联系人升级链。它的价值只在故障现场体现，所以形态要可搜索、步骤要能直接复制执行，并随架构与参数变更同步更新。
基本信息
| 必备内容 | 拓扑与角色、处置步骤、命令速查、回滚路径、联系人 |
|---|---|
| 形态要求 | 可搜索、命令可复制执行、版本受控 |
| 维护节奏 | 架构、参数、人员变更后立即更新 |
| 检验方式 | 按手册演练一遍，跑得通才算数 |
| 配套动作 | 与告警联动，告警里直接给出手册入口 |
典型使用场景
- 故障处置：值班人员按步骤执行，不依赖个人记忆
- 交接轮岗：新成员靠手册快速掌握拓扑与常见问题
- 演练验收：定期演练检验手册与现网是否一致
- 变更执行：升级与回滚路径提前写好，变更时照做
- 告警联动：告警内容附对应章节，缩短反应时间
手册里的命令要能跑通
手册里的命令要能跑通
redis-cli -c CLUSTER INFO # 集群状态，判断整体是否可用
redis-cli -c CLUSTER NODES # 节点与角色，确认拓扑与手册一致
redis-cli INFO replication # 主从关系与复制状态
redis-cli INFO memory | grep -E 'used_memory_human|maxmemory_human' # 水位检查
redis-cli INFO clients | grep connected_clients章节清单
| 章节 | 内容 | 什么时候更新 |
|---|---|---|
| 拓扑与角色 | 实例、分片、主从关系与负责人 | 扩容或迁移之后 |
| 故障处置 | 典型故障的判断依据与操作步骤 | 每次复盘之后 |
| 命令速查 | 连接、查看、切换、回滚命令 | 参数或版本变化后 |
| 升级与回滚 | 升级步骤与回滚判据 | 每次发布之后 |
手册的可执行性靠演练检验：照着做一遍能跑通才算数。纸面完整但命令已过期的文档，在故障现场会直接把人带偏。
过期手册比没有手册更危险，照着操作可能指向不存在的节点或错误的实例；把手册更新写成变更流程的收尾步骤，并指定责任人。