mcpField
R
runbook-generator

runbook-generator

github.com/alirezarezvani云与 DevOps28.9k606 次安装2 天前更新
代码仓库

关于 runbook-generator

runbook-generator 是面向 DevOps 和站点可靠性工程团队的命令行技能，可按服务名称生成运维手册框架，并供团队补充部署、事件响应、维护和回滚细节。

主要功能

  1. 01按服务名称生成手册框架
  2. 02包含启动、停止、健康检查和回滚章节
  3. 03提供事件升级与处理占位内容
  4. 04附带部署和事件响应模板

适用场景

  1. 01为缺少手册的服务建立初始文档
  2. 02统一团队运维手册格式
  3. 03为值班人员准备标准操作文档
  4. 04为新服务搭建可重复的手册结构

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/alirezarezvani/claude-skills --skill runbook-generator

安装后在 Claude Code 中输入/runbook-generator确认已加载。

附带文件references/runbook-templates.mdscripts/runbook_generator.py

详细介绍

Runbook Generator

Tier: POWERFUL
Category: Engineering
Domain: DevOps / Site Reliability Engineering

Overview

根据服务名称快速生成运维 Runbook，然后针对部署、事件响应、维护和回滚工作流进行定制。

Core Capabilities

  • 通过命令行生成 Runbook 骨架
  • 启动/停止/健康检查/回滚的标准章节
  • 结构化的升级和事件处理占位内容
  • 部署和事件应急手册的参考模板

When to Use

  • 服务尚无 Runbook，需要立即获得基础版本
  • 各团队的现有 Runbook 风格不一致
  • 值班人员入职需要标准化的运维文档
  • 新服务需要可重复使用的 Runbook 脚手架

Quick Start

# Print runbook to stdout
python3 scripts/runbook_generator.py payments-api

# Write runbook file
python3 scripts/runbook_generator.py payments-api --owner platform --output docs/runbooks/payments-api.md

Recommended Workflow

  1. 使用 scripts/runbook_generator.py 生成初始骨架。
  2. 填写服务特定的命令和 URL。
  3. 添加验证检查和回滚触发条件。
  4. 在预发布环境中试运行。
  5. 将 Runbook 与服务代码一起存放在版本控制中。

Reference Docs

  • references/runbook-templates.md

Common Pitfalls

  • 缺少回滚触发条件或回滚命令
  • 步骤没有预期输出的检查
  • 负责人/升级联系人信息过时
  • Runbook 从未在事件之外进行测试

Best Practices

  1. 确保每条命令都可以直接复制粘贴执行。
  2. 在每个关键步骤之后加入健康检查。
  3. 以固定的评审节奏验证 Runbook。
  4. 在事件和复盘之后更新 Runbook 内容。

评论

支持 Markdown