CI/CD パイプライン設計シート(製品非依存)
説明
CI/CD パイプラインの設計シート。製品には依存しません(Jenkins / GitLab / GitHub Actions など何を使っても決めることは同じです)。★核は3枚です。(1)止める仕組み … 自動化の値打ちは「速く出せる」ことではなく「間違ったものを止められる」ことです。止める条件を決めずに自動化すると、壊れたものが速く本番へ届くようになります。特に「失敗しても進む」設定を1つでも作ると、以降そこは常に通ります。試験の実行件数も見てください。0件でも「成功」になる仕組みが多く、試験が動いていないのに緑に見えます。(2)権限と資格情報 … パイプラインは本番を変えられる権限を持ち、人より強くなりがちです。資格情報がログに出た瞬間、見た人全員が本番を触れるようになります。(3)設定時の注意 … この分野で実際に起きる24の失敗と、その回避手順。★既定値は製品と版で変わるため、確証のあるものだけを記載し、それ以外は「要確認」と明記しています。
使い方
★止める条件を先に決めてから、速さを詰めてください。順番を逆にすると、止める条件が「速さの邪魔」として1つずつ外されていきます。★「失敗しても進む」設定を置くなら、期限と外す条件を必ず書いてください。書かない例外は永久に残ります。★不安定な試験を「たまに落ちるから無視」にしないでください。本物の失敗も一緒に見えなくなります。★試験の実行件数を毎回見て、前回より減っていたら止めてください。減ったことに気づけないのが最も危険です。★環境ごとにビルドし直さないでください。1回作って同じ成果物を各環境へ配ります。検証で試したものと違うものが本番へ行きます。★承認者は実行者と別にしてください。同じ人だと承認の記録に意味がありません。★出す仕組みと同じだけ、戻す手順を整えてください。速く出せるようになると、速く壊せるようにもなります。★止まることを実際に試して確かめてください。わざと違反を入れて流し、止まることを見ます。設定を読むだけでは確かめられません。★資格情報がログに出ないことを、実際にログを検索して確かめてください。誤って出たら、値そのものを失効させます。
収録内容
全9シート。各シートに書いてあることは次のとおりです(ファイルの「目次」シートより)。
- 前提共通設計
- 適用範囲・実行環境・きっかけ・記録
設定項目(16件)
自動化する範囲・自動化しない作業・対象の環境・パイプラインの持ち主・実行する場所・実行環境の版・同時に走る数・実行時間の上限・成果物の置き場・保管期間・何で動き出すか・夜間・休日の扱い・手動で止められるか・実行の記録・変更管理表との対応・通知先
- 設定値段の設計
- 取得・ビルド・試験・配布・戻し
設定項目(15件)
コードの取得・書き方の検査・ビルド・成果物の保管・自動試験の範囲・手で行う試験・試験の記録・落ちたときの扱い・検証への配布・本番への配布・配布の方式・配布後の確認・戻す手順・戻す判断・戻しの実測
- 設計止める仕組み
- ★速く出すためではなく、間違ったものを止めるために組む
- 設計権限と資格情報
- ★パイプラインは人より強い権限を持ちやすい
- 確認確認項目
- ★止まることを実際に試して確かめる
- 注意設定時の注意
- この分野で実際に起きる失敗と、その回避手順
この型で検査する
記入済みのファイルをアップロードすると、この型の必須項目(パラメータシートの組込みルール)を満たしているか検査します。ファイルは保存されません。
関連するテンプレート
同じフェーズ(設計)や業界でよく使われている型です。
基本設計書(方式と方針の型)
「基本設計=方式と方針、詳細設計=具体的な値」の線引きを章構成で体現。設定値はパラメータシートに書き、本書には書かないことで二重管理を防ぎます。
IPアドレス管理表
セグメントの全アドレスを行に展開する台帳。「空き」が行として見えることで、重複払い出しを防ぎます。★セグメントごとの使用率を数式で出します(80%超で橙、90%超で赤)——IPは足りなくなってから増やせず、/24 を /23 へ広げるにはそのセグメントの全機器のアドレスを変えることになるためです。★ホスト名の重複を自動で検出し、使用中なのに用途・ホスト名が空の行、最終更新から1年以上動いていない行も色で出します。.0(ネットワークアドレス)と .255(ブロードキャスト)も「禁止」の行として残し、なぜ払い出せないかが見えるようにしました。★v3 では「実体(実機/仮想IP/機器のIF)」の列を追加しました。VIP・フローティングIP・ゲートウェイのSVIは★機器一覧に出てこないのにアドレスを消費するので、台帳に載せ忘れると後から同じIPを別の機器へ払い出して本番で衝突します。実機なのに機器IDが空の行は赤、仮想IPは薄紫で区別し、セグメント一覧に「うち仮想IP」の件数も出します(記入例はサーバー10台に対して使用中が14個になります)。払い出し記録シートつき。
構成図テンプレート(作図ルール+部品集)
雛形・記法ルール・アイコン部品集のセット。新設=赤枠/撤去=グレーアウトなど更改案件の描き分けを標準化します。Visio不要、PPT標準図形のみ。
通信要件一覧(FWルール表)
ゾーン定義とゾーン間ポリシーを先に決め、個別ルールをその例外として書くFWルール表。送信元・宛先・サービスが any の行と、有効期限が過ぎた行には自動で色が付きます。★ゾーン間ポリシーに「≠(この区間はFWを通らない)」の記号を持たせてあります。VLAN間ルーティングをコアスイッチで行う構成では社内セグメント同士の通信がFWまで上がってこないため、ここを「×」と書くと止まっているつもりで素通りします。効かないルールの例と、棚卸しでヒット0からそれを見つける流れまで記入例に入れてあります。AD認証の内訳やIPsec・vSphereなど、毎回調べ直しているポート番号を約60件収録済み。FW機種を問わず使えます。
