SuperAPI AI 工具集

runbook-creation

部署与运维

查看项目

更新于 10-28 04:52

技能介绍

该技能用于创建运维手册、标准操作流程(SOP)、值班流程和事故恢复指南,目标是让值班工程师在紧急情况下也能按文档执行。

主要能力

  • 提供完整的手册模板结构:标题、负责人、最后审阅日期、版本、不可用时的严重级别、概述、前置条件、编号操作步骤、验证、回滚、故障排查表、升级联系人和相关手册、变更日志。
  • 示例:PostgreSQL 主库故障切换到同步副本,覆盖计划内和紧急切换,含副本健康检查、停止应用写入、隔离旧主库并确认写入静止、晋升副本、更新 DNS、重启应用、验证与升级。
  • 附带常见操作的自动化脚本示例:服务健康检查(curl 检查多个 /healthz)、事故日志收集(kubectl logs、CloudWatch Logs、数据库活动查询、pod 资源快照并打包归档)、TLS 证书到期检查(openssl 检查 30 天内到期)、磁盘空间清理(先盘点,不执行删除)。
  • 提供手册审阅清单,分为内容审阅、可用性审阅、维护审阅三部分。
  • 提供测试策略:每次创建或大改后在预发环境演练;每次编辑后进行同行评审;每季度随机抽取 5 份手册在预发环境执行;事故后复盘评估手册准确性;CI 中用 shellcheck 校验脚本。

使用方式 以模板为骨架,按服务或流程填写前置条件、可复制命令、预期输出、验证检查、回滚步骤和升级联系人;脚本部分可直接参考示例中的 bash 片段,按需替换占位主机名和账号。

适用场景 创建或更新运维手册、SOP、值班流程、事故恢复指南,以及为关键服务编写可执行的故障处理步骤。

限制

  • 手册必须在预发环境验证;示例中的主机名、账号 ID 均为占位。
  • 该技能为文档型导入,上游模板文件和辅助脚本未捆绑提供。
  • 脚本示例假设 Linux/GNU date、curl、jq/openssl 以及有权限的集群和云访问;网络探测应设置超时,收集的日志和查询结果需保护,临时目录并不使原始事故数据可安全公开。
  • 回滚部分说明晋升操作不能通过恢复备份撤销,需建立权威主库、隔离其它写入者并取得 DBA 批准的数据恢复/重新加入计划;RDS 快照恢复示例不是自管理 PostgreSQL 的自动回滚。