用途
devops-runbooks 是一个面向运维手册与流程文档的专用技能,用于创建可执行的 runbook,覆盖运维操作流程、事故响应和系统维护。它帮助团队把口头或分散的运维经验整理成结构化的文档,便于值班人员、维护人员和交接对象直接使用。
主要能力
根据资料,该技能可以:
- 创建运维 runbook
- 记录事故处理程序
- 定义升级路径
- 提供故障排查指南
- 记录回滚流程
- 沉淀运维知识
使用方式
资料未提供具体的安装命令、调用方式或代码示例,因此这些内容暂未提供。已知该技能附带一个参考文件:references/RUNBOOK.template.md,提供完整的运维手册格式,可作为编写 runbook 的模板参考。
手册结构
Runbook 建议包含以下部分:
- Overview(概述)—— 用途以及何时使用
- Prerequisites(前提条件)—— 所需的访问权限和工具
- Quick Reference(快速参考)—— 关键命令和 URL
- Procedure(操作步骤)—— 逐步操作并包含验证
- Rollback(回滚)—— 如何撤销变更
- Troubleshooting(故障排查)—— 常见问题
- Escalation(升级)—— 何时以及如何升级
适用场景
- 事故响应规划
- 值班(on-call)文档
- 系统维护流程
- 灾难恢复规划
- 知识传递
最佳实践
资料给出的最佳实践包括:
- 命令必须可复制粘贴
- 为每个步骤包含预期输出
- 清晰记录决策点
- 在每个步骤定义回滚方式
- 保持流程最新(定期测试)
- 包含升级联系人
限制
资料未说明该技能支持的具体平台、依赖环境、是否收费以及价格等信息,这些内容暂未提供。