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

詳細

ランブックジェネレーター

ティア： 強力
カテゴリー： エンジニアリング
ドメイン： DevOps／サイト信頼性エンジニアリング

概要

サービス名を指定して運用ランブックをすばやく生成し、デプロイ、インシデント対応、メンテナンス、ロールバックのワークフローに合わせてカスタマイズできます。

主な機能

  • CLI からのランブックのひな形生成
  • 起動／停止／ヘルスチェック／ロールバックの標準セクション
  • エスカレーションとインシデント対応用の構造化されたプレースホルダー
  • デプロイおよびインシデント対応プレイブック用の参照テンプレート

使用する場面

  • サービスにランブックがなく、すぐに基本的なものが必要な場合
  • チーム間で既存のランブックに一貫性がない場合
  • オンコール担当者のオンボーディングに、標準化された運用ドキュメントが必要な場合
  • 新しいサービス向けに再利用可能なランブックのひな形が必要な場合

クイックスタート

# 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

推奨ワークフロー

  1. scripts/runbook_generator.py で初期のひな形を生成します。
  2. サービス固有のコマンドと URL を記入します。
  3. 検証チェックとロールバックのトリガーを追加します。
  4. ステージング環境でドライランを実施します。
  5. ランブックをサービスコードの近くにあるバージョン管理システムに保存します。

参考ドキュメント

  • references/runbook-templates.md

よくある落とし穴

  • ロールバックのトリガーやコマンドが記載されていない
  • 手順に期待される出力の確認が含まれていない
  • 担当者やエスカレーション先の連絡先が古い
  • インシデント発生時以外にランブックがテストされていない

ベストプラクティス

  1. すべてのコマンドをコピーしてすぐに実行できるようにします。
  2. 重要な手順の後には必ずヘルスチェックを含めます。
  3. 定められた周期でランブックを検証します。
  4. インシデントやポストモーテムの後にランブックの内容を更新します。

コメント

Markdown 対応