テーマ別の解説テーマ:復旧とIaC配信のトラブル調査
GitHub ActionsでCDK synthが参照エラー|Constructとスタックの依存を確認
配信を再実行する前に、どの段階で参照できないかを確かめます。 同じキーを使う二つの構成を比べ、合成時と配信時を分けます。
Constructの生成、スタックの境界、テンプレート生成の状態を区別し、公開前に修正すべき参照を特定する。
実AWSやGitHub Actionsは動かさず、架空の合成ログとスタック構成を読みます。
生成していないConstructの属性を読む失敗を追う
CDKではConstructをまとめたスタックが配信単位です。テンプレート生成前に必要な参照をアプリで作れるかを確かめます。テンプレートの配信順は後の別段階です。
- 入力 → 参照条件を比較
- 参照 → 合成止まった段階を把握
- 合成 → 配信生成結果を照合
- 入力
- プレビューでは保存スタックなし
- 参照
- アプリが保存先属性を読む
- 合成
- 参照できずテンプレートなし
- 配信
- 成果物がそろうまで保留
同じrevisionの二つの環境設定を比べる
| 段階 | 検収環境 | プレビュー環境 |
|---|---|---|
| 保存スタックの作成 | 有効 | 無効 |
| 保存先を読む処理 | 有効 | 有効のまま |
| CDK synth | 必要なテンプレートが出る | 未生成の参照で停止 |
| CloudFormationへの送信 | この観測には含まれない | 未実行 |
CloudFormationの参照やDependsOnで表す順序は、生成されたテンプレート内のリソースに作用します。保存先を作らない分岐でConstructの属性を読む問題は、先にCDK側の構成を正します。
不整合を直し、生成物を対象と結び付ける
同じ入力で合成箇所を見る。 環境の入力、スタックの作成条件と利用側の条件を並べます。参照先が無い構成では利用側も作らないか、仕様上の代替を設けます。
合成と配信を区別する。 合成に成功した後でテンプレートの参照と配信順をレビューします。CDKのオブジェクトを生成する問題を配信順だけで解決しようとしません。
別の成功を流用しない。 同じrevisionでも対象環境と構成が異なるため、両方で合成し、その成果物と環境・revisionを対応させます。
固定例で判断する
選択すると、正誤と理由が表示されます。
確認して、自分の言葉で説明する
- 止まった段階をログから特定する。
- 作成と参照の条件を比較する。
- 対象環境の合成成果物を確認する。
理解を確かめる: 別環境の合成が成功した証拠は今回に使えますか?
参照の作成条件が揃った対象環境で合成し直します。
revisionと環境の組み合わせで検証結果を扱います。
出典と確認した条件
説明に用いた公式資料を、確認した内容・条件と本文の参照箇所に分けてまとめています。専門家による監修・実際のAWSとの比較検証は行っていません。
確認した内容・条件スタック境界と同じアプリ内外の依存。
確認した内容・条件リソース間の暗黙の参照と明示的な順序。