ランブックを作成する
ℹ️ 情報 ランブックを作成することでインシデント対応時に対応手順を順に表示できます。ランブックとインシデントを紐付けるにはランブックとインシデントを紐付けるを参照ください。
1. 作成方法
ランブック一覧から作成画面へ遷移する
一覧画面の「ランブックを作成する」ボタンを押してランブックの作成画面へ遷移します。
ランブックの情報を入力する
ランブックは以下の2つの要素で構成されています。
| 項目 | 説明 |
|---|---|
| ネームスペース | ランブックのネームスペースを設定します。必ず / から書き始め、任意の文字列でネームスペースを切れます。階層を作りたい場合は新たに / で区切ります。<br>例: /topotal/alertmanager/SiteWentDown |
| 本文 | Markdown を用いてランブックの内容を記述します。Overview、Dashboard、Precheck、Resolution の4つで構成されます。 |
本文の４つの構成
| セクション | 説明 |
|---|---|
| Overview | このランブックが必要となった時、対象のサービスにどのような問題が発生しているかを記述します |
| Dashboard | インシデント対応に必要な情報を得るためのモニタリングツールなどの URL やその見方を記述します。 |
| Precheck | 復旧作業を始める前に確認すべき項目をステップ毎に記載します。Precheck 下に h3 ### で区切ったセクションがステップとして扱われます。ステップのタイトルは任意です。 |
| Resolution | 復旧作業の具体的な手順をステップ毎に記載します。Resolution 下に h3 ###で区切ったセクションがステップとして扱われます。ステップのタイトルは任意です。 |
ランブック例
## Overview
アプリサーバー上で動作しているnginxが停止している。
## Dashboard
- [Grafana ダッシュボード](https://sample.grafana.net/d/hoge)
## Precheck
### systemctl status
以下のコマンドを実行してステータスを確認してください
```
systemctl status nginx.service
```
### journalctl error log
以下のコマンドを実行して何か手がかりとなるメッセージが出力されないか確認してください
```
journalctl -xe -u nginx.service
```
## Resolution
### systemctl restart
nginx の再起動を実行してください
```
systemctl restart nginx.service
```
### systemctl status
正しく起動したかを確認してください
```
systemctl status nginx.service
```
2. ランブックの表示
ランブックはランブックルールに則ってインシデント発生時に表示されます。ランブックルールの設定方法に関してはランブックとインシデントを紐付けるを参照ください。
