AWS CDKの新機能「cdk migrate」を試してみた

AWS CDKの新機能「cdk migrate」を試してみた KMiura(@k_miura_io)

自己紹介 • 三浦耕生（こうき） • 三次元地図のスタートアップのエンジニア • JAWS UG名古屋運営 •
好きなAWSのサービス： AWS IoT、 Lambda、ECS、AWS CDK @k_miura_io koki.miura05

AWS CDKとは？ • AWSのサービス構築をアプリケーションをコードで定義するためのIaCツール • モダンなプログラミング言語でAWSのアプリケーション構成を定義することで CloudFormationのテンプレートを作成できる

Terraformとの違いは？ Terraform AWS CDK 対応言語独自の言語 TypeScript, Python, Goなど対応クラウド
AWS、Azure、GCPなど AWS ライセンス Business Source License(BSL) Apache-2.0 license

CDKは頻繁にアップデートがある • OSSで様々な開発者がコントリビュートしている • 現行のV2のマイナーバージョンは100超え • Experimentalで新機能をお試しできる(あくまで検証目的) • 新機能のアップデート情報は #cdk_releases
でキャッチアップするのがおすすめ(今回のネタもここから選択した)

Migrateコマンドが導入された • CloudFormationのテンプレート（json, yaml）やデプロイ済みのCloudFormationスタックからCDKのアプリケーションを構築する機能 • テンプレートやスタックから変換されるCDKはL1コンストラクト(CloudFormationのリソースに対応したコンストラクト)として作成される • それまでは手作業で行う必要があったCloudFormationからCDKへの移行作業が効率
よくなりそう • 2023/10現在はExperimentalでの提供

試してみた

今回構築するスタック

テンプレートの用意 • カスタムドメインを指定してS3でホスティングされるWebサイトを構築 • https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/ sample-templates-services-ap-northeast-1.html で公開しているサンプルのテンプレートを用意

テンプレートからCDKアプリを作成 cdk migrate --stack-name CDKHelloWorld --language typescript --from-path ./S3_Website_With_CloudFront_Distribution.template

テンプレート生成したらエラーに…

なぜエラーになったのか？ • 作られたスタックを呼び出すときに必要なプロパティに変数が定義されていた • スタックを呼び出す時のアプリケーション側ではそのプロパティの変数が何も設定されてなかったので追加してみた(今回の場合はホストゾーンを指定した) スタック側(プロパティの定義) アプリ側(スタックの呼び出し時)

もう少し掘り下げてみた • マネジメントコンソールを使って同じテンプレートから構築するとスタックの詳細設定のときにホストゾーンを聞かれる • cdk migrateではこのパラメータを聞くところがプロパティの変数としてスタックで呼び出すときに設定するように作られているよう

それでもエラーに…

このエラーの原因は？ • スタック内でデプロイ先のリージョン名を参照しているが、そのデプロイ先のリージョンをアプリケーション側で何も設定していない • 実はアプリケーション側ではリージョン名、アカウントIDを定義するenvオブジェクトはコメントアウトしてたスタック側(リージョンを参照している) アプリ側(envオブジェクトの定義を追加)

無事にCloudFormation のテンプレートが再生成された🎉

おまけ • WordPressを構築するスタックを作ろうとしたらエラーが大量に出まくった… • EC2上で構築するコマンドとかが定義されているのが原因かもしれないけど、これだけエラーあったら自分で一から構築したほうが早いかも…

まとめ • CloudFormationで構成したスタックをCDKに移行することができた • そのままデプロイできなくて多少手直しが必要になることもあり • 非対応のスタックなどもあったりするので、まだまだ伸びしろがある • CloudFormationのテンプレートから改造するときにCDKに変換すればAWSの環境構築が効率よくなるかも

AWS CDKの新機能「cdk migrate」を試してみた

AWS CDKの新機能「cdk migrate」を試してみた

KMiura

More Decks by KMiura

Other Decks in Technology

Featured

Transcript