レビュー可能なプラン成果物を生成する

GitBeginner
オンラインで実践に進む

はじめに

チームはレポートストアを変更したいと考えていますが、レビュアーはプランがどの設定と環境を表すのかを正確に把握する必要があります。latest.tfplan のようなファイル名だけでは、その関係は確立されません。

小さなレポート変更をコミットし、具体的な保存済みプランを 1 つ生成して、読みやすい変更内容、JSON の変更内容、コンテキストのフィンガープリントを確認します。用意された実行プログラムは、すでに練習した品質ゲートを実行し、選択した Git リビジョンを別の成果物ディレクトリに書き出します。この実験は、レビューの承認や適用の前で終了します。

Terraform の状態と環境分離、モジュールの契約、基本的な Git のコミットと差分、前のデリバリー品質ゲートを理解していることを前提とします。各実験は独立して開始します。ここにある 2 つの既存レポートストアは、以前の実験から引き継いだものではありません。

認定試験との関連

認定資格 試験のタスク 演習内容
DevOps Engineer – Professional (DOP-C02) Task 1.3 具体的なローカルプランを通じて、成果物の生成と追跡可能性の基礎を学びます。AWS の成果物リポジトリやビルドサービスとの連携を扱うものではありません。

選択した Git リビジョンから、ソース、ロック、環境のコンテキストが明示された保存済みプランとレビュー用成果物を生成します。

リリース案をコミットする

このステップでは、小さな設定変更を行い、その正確な Git リビジョンを選択します。保存済みプランは、後で作業ディレクトリにたまたま存在する編集ではなく、コミット済みのソーススナップショットを表す必要があります。

準備済みのリポジトリに移動し、ツールを読み込みます。

cd /home/labex/project/report-release
source environment.sh

用意されたインターフェース、リリース入力、品質チェックのステージを読みます。

cat variables.tf main.tf outputs.tf release.auto.tfvars.json pipeline.json

このモジュールは、各環境のバケットと report.txt を管理します。preview と review は、別々の状態ファイルと、異なる既存バケット delivery-release-preview、delivery-release-review を使用します。現在、両方に release one report が入っています。別の delivery-release-neighbor/keep.txt は、保持する必要がある無関係のデータです。

release.auto.tfvars.json は、リリースラベルとレポートの文面を渡します。Terraform は、この変数ファイルを選択した設定に読み込みます。pipeline.json は、書式、構造の検証、plan モードのモジュールテストを維持し、その後、用意された実行プログラムが保存済みプランを生成します。用意されたモジュール、プロバイダー、依存関係のロック、テスト、環境スクリプト、実行プログラムを保持してください。この実験で行う設定変更は、リリース入力ファイルです。

提案するリリースを書き込みます。JSON のエスケープシーケンス \n は、レポート内の改行を表します。引用符付きの区切り語を使うヒアドキュメントは、ファイルへの書き込み時にそのエスケープを保持します。

cat > release.auto.tfvars.json <<'EOF'
{
  "release": "release-two",
  "report": "release two report\n"
}
EOF

記録する前に変更を確認します。git diff -- は、このファイルを現在のコミット済みバージョンと比較します。

git diff -- release.auto.tfvars.json

差分は、リリースラベルとレポート内容だけを置き換えるはずです。そのファイルだけをステージします。

git add release.auto.tfvars.json

この提案のソーススナップショットを作成します。

git commit -m 'Propose release-two report'

完全なコミット ID を別に記録します。git rev-parse HEAD は現在のコミットを解決し、> が結果をファイルに書き込みます。この選択ファイルは Terraform 設定の一部ではなく、未追跡のままにしてください。

git rev-parse HEAD > selected-revision.txt

選択したリビジョンと作業ツリーの状態を読みます。

cat selected-revision.txt
git status --short

完全なコミット ID と、未追跡の選択ファイルが表示されるはずです。選択を記録することで、リポジトリが先に進んでも、後のコマンドは同じリビジョンを使えます。明示的に選択した有効な古いコミットも許可されます。実行プログラムは、すべての成果物に最新の HEAD を要求するものではありません。

具体的なプランを生成して確認する

このステップでは、選択したソースを、適用せずにレビュー可能な成果物に変えます。保存済みのバイナリプランには Terraform が提案する操作が含まれ、読みやすい形式と JSON 形式で、その操作を確認しやすくします。

preview 用に名前付きの成果物を生成します。$(cat selected-revision.txt) は、記録したコミット ID を引数に代入します。--environment が対象の状態とバケットを選択します。成果物のファイル名から推測されるわけではありません。

python3 delivery.py plan report-two --revision "$(cat selected-revision.txt)" --environment preview

用意されたワークフローは、その Git スナップショットを書き出し、読み取り専用の依存関係ロックを使って固定バージョンのプロバイダーを初期化し、fmt/validate/test を実行してから、-out と -detailed-exitcode を付けて Terraform 標準のプラン作成を呼び出します。すべての品質ゲートが通過し、リリースタグとレポート内容の 2 つの更新を含むプランになるはずです。追加や削除があってはいけません。

変更が存在するため、Terraform 自体の plan は 2 を返します。それを呼び出す delivery コマンドは、成果物を正常に生成したため 0 を返します。一方、Terraform のエラーはジョブを失敗させます。成果物名は一意です。曖昧な最新プランを上書きするのではなく、新しく生成するときは新しい名前を使ってください。

用意されたエントリーポイントを通じて、成果物を確認します。

python3 delivery.py inspect report-two

出力には、Terraform の読みやすいプランと、記録されたコンテキストが含まれます。対象バケットが delivery-release-preview、新しいリリースが release-two、レポートが release two report になることを確認してください。Terraform 自体のプランの要約は 0 to add, 2 to change, 0 to destroy と表示されるはずです。~ は、既存リソースをそのまま更新する操作を示します。

マニフェストを直接読みます。

cat /home/labex/project/.delivery-release/artifacts/report-two/manifest.json

revision を selected-revision.txt と照合し、environment が preview であることを確認します。source_sha256 は書き出された追跡対象ソースのフィンガープリント、lock_sha256 は正確な依存関係ロック、plan_sha256 は具体的なバイナリプランを識別します。読みやすい形式と JSON 形式にも、それぞれのフィンガープリントがあります。これらのフィールドは成果物の異なる部分を表します。ファイル名の一致だけで代用はできません。

実際のファイルのバイト列から SHA-256 を計算する sha256sum で、ロックとプランのフィンガープリントを比較します。

sha256sum .terraform.lock.hcl /home/labex/project/.delivery-release/artifacts/report-two/release.tfplan

2 つのダイジェストは、マニフェストの対応するフィールドと一致するはずです。実行プログラムは、プロセスをまたいで保持される生成記録も持ち、実際のバイナリプランを、独立して選択されたソースと環境に照らして確認します。マニフェストを編集して別のバイト列を記述しても、そのバイト列が有効な成果物になるわけではありません。

機械で処理できる操作一覧を読みます。準備済みの jq ツールは、Terraform 標準の JSON 形式から各リソース変更を選択し、アドレスと操作リストを表示します。

jq '.resource_changes[] | {address, actions: .change.actions}' /home/labex/project/.delivery-release/artifacts/report-two/plan.json

aws_s3_bucket.reports と aws_s3_object.report が表示され、どちらも update 操作のはずです。この JSON は保存済みプランを機械で処理できる形式で表したもので、それ自体が何かを適用するものではありません。実際のプランにはレポートの文面や設定の入力値が含まれる場合があるため、レビュー用に共有するときは、データを含む成果物として扱ってください。

既存の preview のレポートが変更されていないことを確認します。

aws s3 cp s3://delivery-release-preview/report.txt -

プランを生成しても提案した内容は適用されないため、引き続き release one report と表示されなければなりません。もう一方の環境も確認します。

aws s3 cp s3://delivery-release-review/report.txt -

同じ元のレポートが表示されるはずです。最後に、無関係の隣接データを読みます。

aws s3 cp s3://delivery-release-neighbor/keep.txt -

preserve release neighbor と表示されるはずです。作成したのはローカル成果物であり、デプロイ済みスタックではないため、新たに削除すべきインフラストラクチャはありません。評価のために、これらの既存ストア、その状態、成果物を保持してください。後の実験では、独立したレビューと制御された適用の手順を扱います。

まとめ

リリース案をコミットし、その正確な Git リビジョンを選択して、品質ゲートが通過した後に具体的な保存済みプランを生成しました。実際のレポートデータと業務状態を変更せずに、読みやすい形式と機械で処理できる形式の操作を確認し、ソース、依存関係ロック、環境、プランのフィンガープリントを比較しました。

成果物は具体的な提案であり、承認や適用ではありません。後のワークフローがそれをレビューして使用するときも、ソースのコンテキストと実際のバイト列の整合性を維持する必要があります。ここで使用した標準形式については、公式の保存済みプランのドキュメントと JSON 出力リファレンスを参照してください。