CloudFormation IaC generatorを使った既存AWS環境の管理方法 / Managing existing environment with AWS CFn IaC generator

2024/02/05にリリースされた AWS CloudFormation IaC generator (Infrastructure as Code generator) を使い、手で作った環境をCloudFormationまたはCDKで管理するためのファーストステップガイドです。操作イメージのスクリーンショットも付いています。
まず操作感をイメージしていただくための資料であって、諸条件を網羅したものではありませんのでご注意ください。

詳細は以下のサイトもご覧ください。

AWS CloudFormation にアプリケーション全体をインポート
https://aws.amazon.com/jp/blogs/news/import-entire-applications-into-aws-cloudformation/

Announcing CDK Migrate: A single command to migrate to the AWS CDK
https://aws.amazon.com/jp/blogs/devops/announcing-cdk-migrate-a-single-command-to-migrate-to-the-aws-cdk/

CloudFormation Documentation
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html

Transcript

1. © 2024, Amazon Web Services, Inc. or its affiliates. © 2024, Amazon Web Services, Inc. or its affiliates. ⼤村 幸敬 (ohmurayu@amazon.co.jp) アマゾン ウェブ サービス ジャパン 合同会社 ソリューションアーキテクト CloudFormation IaC generatorを使った 既存AWS環境の管理⽅法 （CloudFormation & CDK） 2024/02/08
2. © 2024, Amazon Web Services, Inc. or its affiliates. AWS環境の管理パターン 2
3. © 2024, Amazon Web Services, Inc. or its affiliates. AWS環境の管理パターン 3 AWSリソース CDK DOC ⼿順書 マネジメントコンソール 作業者 作業者の操作（編集）対象 実際のリソース ⼿作業 CloudFormation利⽤ CDK利⽤ CFnテンプレート CFnスタック CDKコード CDKが内部で⽣成する CFnテンプレート *CFn = CloudForamtion
4. © 2024, Amazon Web Services, Inc. or its affiliates. 既存リソースをCloudFormationで管理する （CloudFormation IaC generator の使い⽅） 4
5. © 2024, Amazon Web Services, Inc. or its affiliates. 既存リソースをCFnで管理する (1/5) 5 AWSリソース DOC ⼿順書 マネジメントコンソール 作業者 作業者の操作（編集）対象 実際のリソース ⼿作業担当者 CloudFormation利⽤者
6. © 2024, Amazon Web Services, Inc. or its affiliates. 既存リソースをCFnで管理する(2/5) 6 AWSリソース 作業者 実際のリソース ⼿作業担当者 CloudFormation利⽤者 CFn IaC generator 実環境全体をスキャン CFn IaC generator スキャン結果
7. © 2024, Amazon Web Services, Inc. or its affiliates. 既存リソースをCFnで管理する(3/5) 7 AWSリソース 作業者 実際のリソース ⼿作業担当者 CloudFormation利⽤者 CFn IaC generator スキャン結果から 対象のリソースを指定して CFnテンプレートの⽣成を指⽰ CFn IaC generator スキャン結果 CFnテンプレート
8. © 2024, Amazon Web Services, Inc. or its affiliates. 既存リソースをCFnで管理する(4/5) 8 AWSリソース 作業者 実際のリソース ⼿作業担当者 CloudFormation利⽤者 CFn IaC generator 「スタックにインポート」 ⽣成したCFnテンプレートと実際のAWSリソースを紐付け CFnスタックを⽣成 CFnテンプレート CFnスタック
9. © 2024, Amazon Web Services, Inc. or its affiliates. 既存リソースをCFnで管理する(5/5) 9 AWSリソース 作業者 実際のリソース ⼿作業担当者 CloudFormation利⽤者 CFnスタック CFnテンプレート 以後CFnテンプレートによるAWSリソース管理が可能になる
10. © 2024, Amazon Web Services, Inc. or its affiliates. 既存リソースをCDKで管理する 10
11. © 2024, Amazon Web Services, Inc. or its affiliates. 参考︓既存環境からCDKコードを⽣成する3つの⽅法 11 AWSリソース CDK CDK利⽤者 CFnスタック CDKコード cdk migrate –-from-stackで、 スタックから CDKコードを⽣成 CFnテンプレート CFn IaC generator スキャン結果 cdk migrate –-from-scanで、 CFn IaC generatorのスキャン結果から CDKコードを⽣成 • CFn IaC generatorスキャン結果 • CFn テンプレート • CFn スタック cdk migrate –-from-pathで、 CFnテンプレートから CDKコードを⽣成
12. © 2024, Amazon Web Services, Inc. or its affiliates. 既存リソースをCDKで管理する (1/3) 12 AWSリソース CDK 実際のリソース CDK利⽤者 CFnスタック CDKコード cdk migrate –-from-stackで、 スタックから CDKコードを⽣成 注: このほかに CFn IaC generatorの結果から⽣成する⽅法 CFn テンプレートから⽣成する⽅法 があります ※「既存リソースをCFnで管理する」を 実施した後の⼿順です
13. © 2024, Amazon Web Services, Inc. or its affiliates. 既存リソースをCDKで管理する (2/3) 13 AWSリソース CDK 作業者 実際のリソース CDK利⽤者 CFnスタック CDKコード cdk diff を使って差分の有無を確認 （対象スタック名を既存のスタック名と⼀致させること） 必要に応じてコードを微調整する ・多くはCDK管理⽤のメタデータリソースの追加のみ （そのままで問題ない） ・migrateしたCDKコードはRemovalPolicyの設定がないが インポートしたCFnスタック上のリソースは RemovalPolicy=Retainとなっているため 必要に合わせてCDKも修正（設定⽅法は後述） Drift detection CDKが内部で⽣成する CFnテンプレート diff cdk diff
14. © 2024, Amazon Web Services, Inc. or its affiliates. 既存リソースをCDKで管理する (3/3) 14 AWSリソース CDK 作業者 実際のリソース CDK利⽤者 CFnスタック CDKコード cdk deployしてCDK側の設定を反映 インポートしたリソースから作ったコードであれば 通常実際のリソースに影響はない 以後CDKによる管理が可能に CDKが内部で⽣成する CFnテンプレート cdk deploy
15. © 2024, Amazon Web Services, Inc. or its affiliates. 参考︓ リソースに⼀括でRemovalPolicy=Retainを設定するコード 15
16. © 2024, Amazon Web Services, Inc. or its affiliates. 既存リソースをCFn/CDKで管理するまでの 作業イメージ 16
17. © 2024, Amazon Web Services, Inc. or its affiliates. 01. CFn IaC generator 画⾯（スキャン実⾏済み） 17
18. © 2024, Amazon Web Services, Inc. or its affiliates. 02. テンプレートの作成 (1) 18
19. © 2024, Amazon Web Services, Inc. or its affiliates. 03. テンプレートの作成 (2) リソースの指定 19
20. © 2024, Amazon Web Services, Inc. or its affiliates. 04. テンプレートの作成 (3) 関連リソースの検出と追加 20
21. © 2024, Amazon Web Services, Inc. or its affiliates. 05. テンプレートの作成 (4) 21
22. © 2024, Amazon Web Services, Inc. or its affiliates. 06. テンプレートの作成 完了 22
23. © 2024, Amazon Web Services, Inc. or its affiliates. 07. リソースをインポート (1) 23
24. © 2024, Amazon Web Services, Inc. or its affiliates. 08. リソースをインポート (2) 24
25. © 2024, Amazon Web Services, Inc. or its affiliates. 09. リソースをインポート (3) 25
26. © 2024, Amazon Web Services, Inc. or its affiliates. 10. スタックインポートの進⾏ 26
27. © 2024, Amazon Web Services, Inc. or its affiliates. 11. スタックインポートの完了 27
28. © 2024, Amazon Web Services, Inc. or its affiliates. 12. CDKコードの⽣成（スタックから⽣成した場合の例） 28 ⽣成されたCDKコード migrate.json コード上の定義と、実体リソースとの紐付けを定義している cdk migrate が⽣成する
29. © 2024, Amazon Web Services, Inc. or its affiliates. 13. 実環境との差分確認 29 CDKに関する Metadata等の差分 （デプロイ上の問題はない） インポートしたリソースはRemovalPolicyがRetainだが cdk migrateで⽣成したコードでは特に指定がないため差分が出る 定義上タグの順番が変わったことによる差分 （デプロイ上の問題はない）
30. © 2024, Amazon Web Services, Inc. or its affiliates. 14. RemovalPolicyを実体に合わせてRetainへ変更 30 再度diffをとって確認→問題なし
31. © 2024, Amazon Web Services, Inc. or its affiliates. 15. CDKをデプロイ（メタデータのみ上書き） 31 変更されるのはメタデータのみ CFn上もメタデータのみ更新
32. © 2024, Amazon Web Services, Inc. or its affiliates. 参考: スタックだけを削除する 32 実体を削除したくない場合は、削除前に対象リソースが Retain になっていることを必ず確認してください︕ CDKが設定したメタデータ等は削除されるが、リソース削除はスキップされている スタックを分割したかったり、 インポート対象を変えたい場合、 実体は残してCFnスタックだけを削除したくなる インポートしたリソースはデフォルトでRetainなので スタックを削除しても 実体は DELETE_SKIPPEDとなる（右図）
33. © 2024, Amazon Web Services, Inc. or its affiliates. © 2024, Amazon Web Services, Inc. or its affiliates. Thank you!