メインコンテンツまでスキップ

デプロイ申請

概要​

デプロイ申請は、プロジェクトバージョンをデバイスへデプロイするための管理された方法です。デバイスへ即座に書き込むのではなく、何をデプロイすべきか、誰がどのような理由で申請したかを記録し、承認権限を持つ担当者による承認を待ちます。承認された後、かつ承認の有効期間内に限り、デプロイを実行できます。

これにより、本番設備に対してフォーアイズ原則(四つの目の原則)を適用できます。変更を準備するエンジニアと、それを承認する担当者が同一である必要はなく、すべての手順が監査のために記録されます。

申請は、デバイスの Deployments タブ内の Requests で管理します。その隣の Jobs ビューにはデプロイの実行そのものが表示され、Deployments ページで説明しています。

Jobs ビューと Requests ビュー、および Request deployment ボタンが表示されたデバイスの Deployments タブ

申請の作成​

ステップ 1 – バージョンを選択し、変更内容を記述する​

Request deployment を選択し、ダイアログの最初のステップに入力します。

Request deployment ダイアログのステップ 1:プロジェクトバージョン、タイトル、説明、動作モード
フィールド説明
Project versionデプロイするプロジェクトバージョン。リストにはバージョン番号、作成日、作成者が表示されます。
Title必須。変更内容の簡潔な要約で、申請リストおよび承認者に送信される通知に表示されます。
Description任意。承認者向けの背景情報 — 何がどのような理由で変更されたか。
Operation mode after deploymentデプロイ完了後にデバイスを Stop Mode または Run Mode のどちらに設定するか。

続行するには Review changes を選択します。

ステップ 2 – 変更内容の確認​

2 番目のステップでは、申請を確定する前に、デプロイによってデバイス上で何が変更されるかを正確に確認できます。

デプロイ済みバージョンとターゲットバージョンを比較する Request deployment ダイアログのステップ 2

サマリーにはデバイス、プロジェクト、タイトルが再表示され、現在デプロイされているバージョンとターゲットバージョンが比較されます。変更されたオブジェクトは Modified と Unchanged として集計され、プロジェクト内のパス(例:Program / Scan / MAIN / ProgPou)で一覧表示されます。Open full comparison を選択すると、2 つのバージョンの完全な並列比較が開きます。

送信するには Request deployment を選択します。最初のステップに戻って入力内容を修正するには Back を選択します。

送信後​

申請は Requested ステータスで Requests リストに表示され、当該デバイスの承認権限を持つすべてのユーザーに通知されます。

ステータス Requested の新しい申請が表示された Requests リスト

リストにはタイトル、ステータス、説明、プロジェクト、バージョン、申請者、作成時刻が表示されます。Expires at と Executed at は、申請が承認され実行されるまで空欄のままです。

申請ステータス​

ステータス意味
Requested送信済みで、承認者を待っている状態。
Approved承認済みで、承認の有効期間が満了するまで実行可能な状態。
Denied承認者が申請を却下しました。実行できません。
Canceled申請者が実行前に申請を取り下げました。
Executed承認された申請からデプロイが開始されました。
Expired実行されずに承認の有効期間が経過しました。新しい申請が必要です。

決定の通知を受け取る​

承認者が申請について決定すると、Deployments 通知カテゴリで設定されたチャネルを通じて通知が届きます。

デプロイ申請が承認されたことを示す通知が表示されたデバイスページ

申請は Approved と、承認の有効期間の終了を示す Expires at を表示します。これらのメッセージを受信する方法や受信の有無を変更するには、Notifications を参照してください。

承認済み申請の実行​

承認された申請を開いて実行します。詳細ビューには申請者、デバイス、プロジェクト、バージョンが再表示され、Created at と Expires at の両方が示されます。

Execute および Cancel request アクションが表示された承認済みのデプロイ申請

Changes タブには、説明、デプロイ済みバージョンとターゲットバージョン、デプロイ後に適用される動作モード、および変更されたオブジェクトの一覧が表示されます。Compare を選択すると完全な比較が開きます。Activity タブには、申請のライフサイクルにおけるすべての手順(作成、承認者のコメントを含む承認、実行)が記録されます。

  • Execute – デプロイを開始します。他のデプロイと同様に実行され、独自の実行ログとともに Jobs に表示されます。
  • Cancel request – デプロイせずに申請を取り下げます。

デプロイは Expires at より前に実行する必要があります。有効期間が経過すると申請は失効し、新しい申請を作成する必要があります。

ユースケース​

  • すべての変更について第二者の承認が必要な本番設備へのデプロイ。
  • 監査および変更管理の記録のために、変更内容とその理由を併せて文書化する。
  • エンジニアがデプロイを準備・確認し、シフトリーダーが実行タイミングを決定する運用。
  • 承認の有効期間を利用して、合意されたメンテナンスウィンドウ内にデプロイを制限する。

詳細情報​