适用场景

Runbook 的价值是把"老师傅脑子里的做法"变成"新人照着也能执行的标准动作"。配上自动化执行，速度快且不会漏步骤。

配置步骤（Runbook 设计规范）

# 结构
# 1) 适用场景与触发条件
# 2) 前置检查（确认环境、确认非高峰）
# 3) 执行步骤（命令 + 预期输出）
# 4) 验证方法（如何确认成功）
# 5) 回滚/补偿步骤
# 6) 记录要求（日志、工单）

关键参数与建议

  • 覆盖场景：服务重启、磁盘清理、扩容、证书更新、故障切换
  • 参数化：目标对象、影响范围、验证方式作为参数
  • 可审计：谁执行、什么时候、执行了哪些步骤、结果如何
  • 风险分级：只读检查类可自由执行；变更类需审批
  • 可回滚：每一步都有回退动作或补偿动作

容易踩的坑

  • 只写命令不写预期输出，无法判断成功
  • 不写前置检查，误操作生产
  • 无回滚步骤，出问题无法收场

验证与巡检

# 证据：Runbook 清单与评审记录
  • 巡检：高频场景覆盖率、季度更新

小结

Runbook 的验收：让一名新同事按 Runbook 独立完成一次服务重启与一次磁盘清理，且有人核查结果。

> 说明：文中命令为通用写法，不同型号/版本可能略有差异，落地前请对照设备实际版本的官方文档；带外管理与安全设备变更建议先在测试设备验证。