はじめに
AWSマネジメントコンソール(マネコン)を利用してAWSサービスを利用したシステムを構築する場合、マネコンのGUI操作により直感的にリソース定義を行うことが可能です。
マネコンでの変更は即座に直接的にそのリソースの定義を変更できるので、何か新機能を試したい場合や動作の検証で一時的に設定値を変えたい場合に便利です。
ただし、定義したリソースが複数に渡り、より大きなシステムになった際にIaC管理して俯瞰して定義内容を把握したり設定値の差分を確認しやすくなることがあります。
今回の記事ではIaCジェネレータを利用して、マネコンを利用して作成したAWSのシステムをIaC管理に移行する手順を解説しています。
同様の内容でJAWSイベントにてLTを行いました
↓LT時の資料
IaCジェネレーターはマネコンとCDKの架け橋になれるのか
↓この記事内容のイメージ
マネコン管理からIaC管理に変更するメリット
・システムの構成やリソースの定義内容をコードで管理するため、差分管理がしやすい
・複数のリソースの画面を1つずつ確認する必要がなくなり、システムの定義内容を一覧で俯瞰して確認できる
・AWS環境に変更内容を適用する前にローカル環境でテストできるので不具合の混入やセキュリティリスクを回避できる
既存のAWS環境のシステムを０からCDKアプリケーションをつくる場合の懸念点
・設計書等のドキュメントを参照してCDKのコードを作成することも可能ですが、その場合、設計書がメンテナンスされておらず、設計書の記載と実際の環境の設定があっていない場合があり、設計書を元にコードを書くことで実際の環境との差異があるコードになる懸念があります。
・実際のAWS環境の画面で設定を確認してCDKコードを書くことも可能ですが、リソースが多い場合にリソース設定画面の確認とCDKコード記載の往復を何度も行う必要があり、多大な時間と手間がかかる懸念があります。
手順
既存のAWS環境にあるシステムをIaCジェネレータを使用してCDKアプリケーションに変換する手順を解説します
１．IaCジェネレーターのコンソール画面を表示
- CloudFormationのコンソール画面の左メニューから「IaCジェネレーター」を選択します
２．スキャンモードを選択する
- 「新しいスキャンを開始」ボタンを選択するとスキャンモードの選択肢が表示されます
- 「すべてのリソースをスキャン」を選択するとサインインしているAWSアカウントの全リソースがスキャンされます。
- 「特定のリソースをスキャン」を選択するとLambdaやStepFunctionsなどのリソースの種類を選択し、選択したリソース（複数可能）のみスキャンするモードになります
- スキャンの時間は1,000リソースで約10分かかります
- スキャンは無料で行えるので、初回は「すべてのリソースをスキャン」してすべてをスキャンし、変更が加えられたリソースがあれば、「特定のリソースをスキャン」でそのリソースを選択するとよいと思います
３．スキャン結果の確認
- スキャン結果は円グラフとリソースの種類ごとの分類で表示されます
- 円グラフはスキャンしたリソースの種類の構成比率が一目でわかり、一覧表示はスキャンできたリソース名が確認できます
４．CloudFormationテンプレートの作成
- スキャンされたリソースからCloudFormationテンプレートを作成します
↓「テンプレートを作成」ボタンを選択してテンプレート作成画面に遷移する
- 最初のステップではテンプレートの名前と削除ポリシー、置換ポリシーを設定します
- 削除ポリシー「保持」：スタックの削除やロールバック時にリソースを削除せずに保持する
- 置換ポリシー「保持」：スタックの置換(リソースを再作成して新しい物理IDを生成する)が発生した時にリソースを削除せずに保持する
- 前回作成したテンプレートに対して新しくスキャンしたリソース定義で更新を行う場合は「既存のスタックのテンプレートを更新」を選択します
↓テンプレート作成画面
- ステップ2ではスキャンしたリソースからテンプレートに含めたいリソースを選択します。
↓スキャンしたリソースを追加
- 「関連リソースを追加」では「スキャンしたリソースを追加」で選択したリソースのロールなどの関連リソースが選択肢として提案されます。
↓関連リソースを追加
５．テンプレートをダウンロード
- テンプレートが作成できたらCloudFormationテンプレートをダウンロードします
- テンプレートの形式はJSONかYAMLのどちらかを選択できます
↓CloudFormationダウンロード画面
- この画面ではCloudFormationテンプレート画面をAWS CDKに変換する手順も提案されています
- この画面にあるCDK変換コマンドをコピーしておき、変換ステップで使用します
↓AWS CDK変換手順提案画面
６．CloudFormationテンプレートをAWS CDKアプリケーションに変換
- ローカル環境でCDK変換コマンドを実行します。
- コマンド実行の結果、CDKアプリケーションが作成されます
↓作成されたCDKアプリケーションのフォルダ
- 変換結果のCDKアプリケーションの中には変換されたコード(今回はTypeScript)以外のCDKアプリケーションに必要なファイルやフォルダも作成されます。
↓フォルダ構成
- 変換後のTypeScriptのコードはほとんどCloudFormationと同じL1コンストラクトになっています
- L1コンストラクトのままで運用を行うことも可能ですが、抽象化などのCDKのメリットをより活かすにはここから手動でL2コンストラクトに変換する作業が必要になります
↓変換前CloudFormationテンプレート
↓変換後CDKコード
さいごに
CDKに慣れた方であればIaCジェネレーターを利用することなく、0からCDKアプリケーションを作った方が早い人もいらっしゃると思いますがIaCジェネレータを使うことでCDKに慣れていない人でも簡単にCDKアプリケーションを作れるため、チームのCDKの熟練度等と合わせて利用を検討してみてください。