AWS CloudShellを活用して簡単に！AWS CDKによるAWSリソース構築(IaC)を体験しよう

AWS CDK
IaC
AWS CloudShell
Handson

Transcript

1. #キャリアチェンジAWSエンジニア AWS CDKによる AWSリソース構築(IaC)を体験しよう AWS CloudShell を活用して 簡単に！
2. 2 IaC (Infrastructure as Code)とは？CDKとは？ インフラを手動で管理・デプロイするのではなく、 「コード」で定義・管理する手法 以下のプログラミング言語 を使用可能 ・TypeScript ・JavaScript ・Python ・Java ・C# ・Go AWS CDK (AWS Cloud Development Kit) ・AWS・Azure・GCPなど 1000以上のクラウドプロバイ ダで使用可能 ・言語はHCL(HashiCorp Configuration Language) ・可読性高い(人間にとって 読みやすい) ・JSONに近い Terraform 等 AWS CloudFormation (Cfn) ・AWSリソースをコードで 定義・管理できるIaC ・データ記述言語はYAML またはJSON
3. 3 1 2 3 AWS CDKとは AWS CDKでの作業内容 AWS ClouldShellを使うメリット 4 ClouldShellでCDK体験 詳細手順 目次
4. 4 1 2 3 AWS CDKとは AWS CDKでの作業内容 AWS ClouldShellを使うメリット 4 ClouldShellでCDK体験 詳細手順
5. 5 ❶AWS CDKとは 前資料「開発事例補足1」参照  インフラを手動で管理・デプロイするのではなく「コード」で定義・管理す る手法=IaC (Infrastructure as Code)のやり方の１つ  TypeScript等６種のプログラミング言語で記述可能 （今回はTypescriptを使用します） AWS CDK (AWS Cloud Development Kit)
6. 6 ❶AWS CDKとは  マイクロソフトによって開発され、2012年に外部公開  JavaScriptをパワーアップさせたプログラミング言語  静的型付け言語（値やオブジェクトの型安全性をコンパイル時に検証する）  ファイル拡張子は基本的に.ts  TypeScript の変数は、let <変数名>: <型> = value; または const <変数名>: <型> = value; という形式で宣言  AWS CDK は６言語サポートしているが、TypeScript が最も早く・優先的に 更新される傾向がある  ドキュメントやサンプルコードが圧倒的に多い →AWS CDKのプログラミング言語がTypescriptがおすすめ 補足：プログラミング言語 Typescript とは
7. 7 1 2 3 AWS CDKとは AWS CDKでの作業内容 AWS ClouldShellを使うメリット 4 ClouldShellでCDK体験 詳細手順
8. 8 ❷AWS CDKでの作業内容 以下をインストール AWS CLI Node.js AWS CDK Toolkit ts-node CLIで cdk init sample-app --language typescriptを実行し サンプルファイルを編集 ローカル環境用意 CLIでcdk init →tsファイルを編集 ・CDK アプリケーションを合成 ・環境にブートストラップスタックをイ ンストール ・CDK アプリケーションをデプロイ cdk synth cdk bootstap cdk deploy 1 2 3
9. 9 1 2 3 AWS CDKとは AWS CDKでの作業内容 AWS ClouldShellを使うメリット 4 ClouldShellでCDK体験 詳細手順
10. 10 ❸ AWS ClouldShellを使うメリット AWSユーザーがブラウザ上で簡単にコマンドライン作業を行えるサービス AWS ClouldShellとは 「1」 ローカル環境用意、が不要！ ▪詳細仕様 ・OS: Amazon Linux 2023 ・ストレージ: 追加料金なしで、リージョン毎に最大 1 GB （もちろんClouldShellから作成したAWSリソースには通常通り課金されるので、試行後作 成したAWSリソースは削除必要） ・AWS CLIをCloudShellから起動できる ・広範な開発ツールがプリインストール済み：node.js、npm （・VPC内でも起動可能(1リージョン同時に最大2個まで)） ・AWS CloudShellの環境は「IAMユーザー単位 + IAMロール単位 + スイッチロール元のIAM ユーザー単位」で分離されている＝他のユーザと同じ画面が見える訳ではない(private to you)
11. 11 1 2 3 AWS CDKとは AWS CDKでの作業内容 AWS ClouldShellを使うメリット 4 ClouldShellでCDK体験 詳細手順
12. １）マネジメントコンソールにログインする 作業を行いたいリージョンを、右上から選択 マネジメントコンソールの最上部 、またはClouldShell検索して押下 → ClouldShellが指定したリージョンで立ち上がる 12 ❹ ClouldShellでCDK体験 詳細手順 ２）起動後のディレクトリは/home/cloudshell-user (pwdで確認可能) ここがClouldShellユーザーのホームディレクトリ ClouldShell 使い始め ３）AWS CDK ワークショップ>TypeScript ワークショップ、の手順を実施し ていく（次ページ以降をご覧ください） https://catalog.us-east-1.prod.workshops.aws/workshops/10141411-0192-4021-afa8-2436f3c66bd8/ja- JP/2000-typescript-workshop
13. 13 ClouldShell 注意点 ▪注意点 ・20~30分の非アクティブ状態が続くとセッションがタイムアウト ・キーボードまたはポインタを使用して 20～30 分間操作しないとシェルセッションは終了 ・実行中のプロセスは、操作数としてカウントされない →タイムアウト後は、再接続(少し時間かかる)すると、タイムアウト前と同じ作業が可能 (CloudShellの仕組み：一時的な計算環境を使い、接続時にホームディレクトリに 保存されたデータを復元する) ・データは、最後のセッションの終了から 120 日間アクションしないと削除されるの で注意！ ・月間使用量制限がある （制限目安：複数名で毎日終日作業していると月末に使用不可。200時間との情報も。） →使用制限で使えなくなったら、試行であれば、他のリージョンで使用すればよい （制限引上申請も可能だが課金される） ❹ ClouldShellでCDK体験 詳細手順
14. １）プロジェクトディレクトリの作成 システム上に空のディレクトリを作成します。(ディレクトリ名はcdk-workshop) 14 CDK TypeScript ワークショップ mkdir cdk-workshop && cd cdk-workshop ２）cdk init cdk init を使用して「TypeScript CDK プロジェクトを作成」します。 ＜解説＞ ・コマンド内容：指定したテンプレートから現在のディレクトリに、新しいAWS CDKプロジェクトを作成 ・テンプレートは以下3種が利用可能 app : CDK アプリケーションの基本テンプレート(空の AWS CDK アプリを作成) lib : CDK コンストラクトライブラリのテンプレート sample-app : CDK アプリケーションのサンプルで、いくつかのコンストラクトが組み込まれている cdk init sample-app --language typescript cdk init <template> --language <language> ❹ ClouldShellでCDK体験 詳細手順 青色ページ：作業手順
15. 15 参考：cdk init実行後の出力結果１ ❹ ClouldShellでCDK体験 詳細手順
16. 16 参考：cdk init実行後の出力結果２ ❹ ClouldShellでCDK体験 詳細手順 この表示が出ることを確認 IPアドレス.リージョン.
17. 17 CDK TypeScript ワークショップ ３）2)の実行で作成された、プロジェクトディレクトリを確認する ・コマンド 等でディレクトリを確認 lib/cdk-workshop-stack.ts ：CDK アプリケーションのメインスタックが 定義されている場所です。 ここで最も時間を費やすことになります。 bin/cdk-workshop.ts ：CDK アプリケーションのエントリーポイントで す。lib/cdk-workshop-stack.ts で定義されたスタックを読み込みます。 package.json ：npm モジュールマニフェストです。アプリケーション 名、バージョン、依存関係、「watch」や「build」などのビルドスクリプ トが含まれます (package-lock.json は npm によって管理されます)。 cdk.json ：アプリケーションの実行方法を AWS CDK Toolkit に指示しま す。この場合、 "npx ts-node --prefer-ts-exts bin/cdk-workshop.ts" にな ります。 tsconfig.json：プロジェクトの TypeScript 設定 です。 .gitignore、npmignore：ソース管理やこのモジュールをパッケージマネー ジャに公開する際に、git と npm が除外する/含めるファイルを指示しま す。 node_modules：npm によって管理され、プロジェクトのすべての依存関 係が含まれます ll ❹ ClouldShellでCDK体験 詳細手順 １⃣ ２⃣ ３⃣
18. 18 参考：cdk-workshopディレクトリで、ファイルが実行される順番 ❹ ClouldShellでCDK体験 詳細手順 cdk.json：CDKコマンドが使う設定ファイル { "app": "npx ts-node --prefer-ts-exts bin/cdk-workshop.ts", "watch": { "include": [ "**" ], "exclude": [ "README.md", "cdk*.json", "**/*.d.ts", "**/*.js", "tsconfig.json", "package*.json", "yarn.lock", "node_modules", "test" ] }, 続く bin/cdk-workshop.tsがCDKアプリ ケーションのエントリーポイント bin/cdk-workshop.ts #!/usr/bin/env node import * as cdk from 'aws-cdk-lib/core'; import { CdkWorkshopStack } from '../lib/cdk- workshop-stack'; const app = new cdk.App(); new CdkWorkshopStack(app, 'CdkWorkshopStack'); lib/cdk-workshop-stack.ts import { Duration, Stack, StackProps } from 'aws-cdk-lib/core'; import * as sns from 'aws-cdk-lib/aws-sns'; import * as subs from 'aws-cdk-lib/aws-sns-subscriptions'; import * as sqs from 'aws-cdk-lib/aws-sqs'; import { Construct } from 'constructs'; export class CdkWorkshopStack extends Stack { constructor(scope: Construct, id: string, props?: StackProps) { super(scope, id, props); 続く lib/cdk-workshop-stack.ts で定義されたスタックを読 み込む
19. ４）bin/cdk-workshop.ts の内容確認、編集 １：ファイルをダウンロードする 19 CDK TypeScript ワークショップ /home/cloudshell-user/cdk-workshop/bin/cdk-workshop.ts ❹ ClouldShellでCDK体験 詳細手順
20. 20 CDK TypeScript ワークショップ ５）bin/cdk-workshop.ts の内容確認、編集 ２：ファイルをダウンロードし、エディタで開く ・Web版のコードエディタ「Visual Studio Code for the Web」へアクセス https://vscode.dev/?vscode-lang=ja 先程ダウンロードしたファイルを 保存しているフォルダを選択 ❹ ClouldShellでCDK体験 詳細手順
21. 21 lib/ bin/cdk-workshop.tsをVisual Studio Code for the Webでを開いたところ bin/ ・最初にこのファイルから実行される ・lib/cdk-workshop-stack.ts で定義されたスタックを読み込む ❹ ClouldShellでCDK体験 詳細手順 スタックについては 21ページで解説
22. ６）lib/cdk-workshop-stack.ts の内容確認、編集 １：ファイルをダウンロードする 22 CDK TypeScript ワークショップ /home/cloudshell-user/cdk-workshop/lib/cdk-workshop-stack.ts ❹ ClouldShellでCDK体験 詳細手順
23. 23 CDK TypeScript ワークショップ ７）lib/cdk-workshop-stack.ts の内容確認、編集 ２：ファイルをダウンロードし、エディタで開く ・Web版のコードエディタ「Visual Studio Code for the Web」へアクセス https://vscode.dev/?vscode-lang=ja 先程ダウンロードしたファイルを 保存しているフォルダを選択 ❹ ClouldShellでCDK体験 詳細手順
24. 24 lib/cdk-workshop-stack.tsを Visual Studio Code for the Webで開いたところ ・CDK アプリケーションの メインスタックを定義。 スタックとは、関連する 1 つ以上の AWS リソースを定 義したもの lib/ bin/ 作業のメイン は、このファ イルの編集！ ❹ ClouldShellでCDK体験 詳細手順 ・CdkWorkshopスタックを export →bin/cdk-workshop.ts 上 で import することで利用 スタックについては 21,22ページで解説 SQS キュー SNS トピック SQS サブスクリプション を作成
25. 25 ❹ ClouldShellでCDK体験 詳細手順 AWS リソースa AWS リソースb スタックとは、 関連する 1 つ以上の AWS リソースを定義 したもの ちょっと 深堀り スタックとは① 画像引用元 https://aws.amazon.com/jp/builders-flash/202309/awsgeek-aws-cdk/
26. 26 ❹ ClouldShellでCDK体験 詳細手順 スタックとは② ・AWS CloudFormationにおけ る、単一のユニットとして管理でき る AWSリソースのコレクション(集 合体)。 ・スタックを作成、更新、削除する ことで、リソースのコレクションを 作成、更新、削除できる。 ・cdk deployを実行すると、 CloudFormationにスタックが作成 され、 それにはリソースとそれらの設定を 指定する CloudFormation テンプ レートのデプロイが含まれる。 CDKは、CloudFormationの仕 組みを使ってデプロイする。 そのためCloudFormationの仕組 みである「スタック」単位に CDKファイルを記述する必要が ある！ ちょっと 深堀り 画像引用元 https://docs.aws.amazon.com/ja_jp/cdk/v2/guide/home.html
27. 27 今回のワークショップで構築するAWSリソース構成図 トピックに発行されたメッ セージを受信するために キューをサブスクライブする (topic.addSubscription) Simple Queue Service (SQS) Queue Simple Notification Service (SNS) Topic SQS キュー (new sqs.Queue) SNS トピック (new sns.Topic) 設定内容： 可視性タイムアウト まで300秒(5分) ❹ ClouldShellでCDK体験 詳細手順
28. ８）CDKアプリケーションを合成する 〔作業内容〕 cdk.json ファイルと同じディレクトリ(=cdk-workshop)で、以下実行 28 cdk synth ❹ ClouldShellでCDK体験 詳細手順 〔説明〕 CDKアプリケーションは、コードを使用 したインフラストラクチャの定義に過ぎま せん。 CDKアプリケーションが実行されると、 アプリケーションで定義された各スタック に対して AWS CloudFormation テンプ レートが生成 (CDK の用語では 「synthesize」、「合成」)されます。 CDKアプリケーションを合成するには、 cdk synth コマンドを使用します。 cdk synth cdk deploy 画像引用元 https://docs.aws.amazon.com/ja_jp/cdk/v2/guide/home.html
29. 参考：cdk synthコマンド実行後の出力内容1 29 ❹ ClouldShellでCDK体験 詳細手順 SNSトピックがSQSキューにメッセージを送信できるようにする IAM ポリシー SQSキューとSNSトピックの間のサブスクリプション SNSトピック SQSキュー 見なくてよい（AWS側で改善に使われる情報） CloudFormationの テンプレート形式が 出力されていること を確認 XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXXXXXXXXXX: XXXXXXXX XXXXXXXX: XXXXXXXX: XXXXXXXX XXXXXXXX XXXXXX XXXXXXXX:
30. 参考：cdk synthコマンド実行後の出力内容2 30 ❹ ClouldShellでCDK体験 詳細手順
31. ９）環境のブートストラップ ・説明：AWS CDK アプリケーションを初めて環境(アカウント/リージョン)に デプロイする場合は「ブートストラップスタック」をAWS CloudFormation に デプロイする必要があります。 スタックの名前は「CDKToolkit」で、このスタックには AWS CDK Toolkit の 操作に使用されるリソースが含まれています。 例えば、このスタックにはデプロイプロセス中にテンプレートとアセットを格 納するために使用される S3 バケットが含まれています。 ・作業：以下コマンドを実行 (実行前にP34 CloudFormation確認オススメ) 31 cdk bootstrap ❹ ClouldShellでCDK体験 詳細手順 次ページで、マネジメント コンソール上でお見せします
32. 補足：ブートストラップ、とは 32 ❹ ClouldShellでCDK体験 詳細手順 〔語源〕 ブーツなどの靴のかかと側にあるつまみの部分。プルストラップ、つまみ革。靴 を履くときに便利な部位 〔意味〕 “つまみ革を掴んで自らを引き上げる”ということわざに由来する動詞。この表現 は、ある人が自分の面倒を見ることができ、他の人の助けを必要としないこと。 〔IT分野〕 コマンドを自動的に読み込み実行するプロセス、を指す
33. 参考：cdk bootstrapコマンド実行後の出力内容 33 ❹ ClouldShellでCDK体験 詳細手順 この表示が出ることを確認 AWSアカウント番号/リージョン名 AWSアカウント番号/リージョン名
34. 確認1：cdk bootstrapコマンド実行後、マネジメントコンソールから、AWS CloudFormationに、スタック名 CDKToolkit ができていることを確認 34 ❹ ClouldShellでCDK体験 詳細手順 2XXX.XX.XX XX:XX:XX UTC+0900
35. 確認2：スタック名 CDKToolkit が作成したリソースを確認 「リソース」タブから確認する 35 ❹ ClouldShellでCDK体験 詳細手順 2XXX.XX.XX XX:XX:XX UTC+0900
36. 作成されたリソースを見てみる 36 ❹ ClouldShellでCDK体験 詳細手順 cdk-
37. 37 ❹ ClouldShellでCDK体験 詳細手順 ちょっと 深堀り スタック「CDKToolkit」 詳細 作成されたリソース11個 SSMパラメータ1個、ECRリポジトリ1個、S3バケット1個、 S3バケットポリシー1個、Role5個、Policy2個 CdkBootstrapVersion：/cdk-bootstrap/hnb659fds/version ContainerAssetsRepository(ECR)：主にDockerイメージの保存に使用 StagingBucket：AWS Lambda関数コードやアセットなどのCDKプロジェクトファイルを保存するために使用 StagingBucketPolicy CloudFormationExecutionRole DeploymentActionRole FilePublishingRole ImagePublishingRole LookupRole FilePublishingRoleDefaultPolicy ImagePublishingRoleDefaultPolicy
38. 10）CDK アプリケーションをデプロイ ・説明：CDK アプリケーションが AWS CloudFormation を通じてデプロイさ れる(P22スライド参照) ・作業：以下コマンドを実行する ・セキュリティ関連の変更を、本当に実施するか確認→yを押下 ・マネジメントコンソールからCloudFormationを開く ・Stackができていることを確認 ・CdkWorkshopStack を選択し、リソースタブ内にSQSができているか確 認→物理IDのリンクを押下し、作成されたAWSリソースを確認する 38 cdk deploy ❹ ClouldShellでCDK体験 詳細手順
39. 39 ❹ ClouldShellでCDK体験 詳細手順 参考：cdk deployコマンド実行後の出力内容１ デプロイ進行中には、以下の様な進捗表示が出る y + Enter 00:00:00 XX 00:00:00 XX
40. 40 ❹ ClouldShellでCDK体験 詳細手順 参考：cdk deployコマンド実行後の出力内容２ 緑色のチェックボックスが表示されていることを確認 リージョン名:AWSアカウント番号
41. 確認1:マネジメントコンソールから、AWS CloudFormationに、 スタック名 CdkWorkshopStack ができていることを確認 41 ❹ ClouldShellでCDK体験 詳細手順 2XXX.XX.XX XX:XX:XX UTC+0900 2XXX.XX.XX XX:XX:XX UTC+0900
42. 確認2:スタック名 CdkWorkshopStack が作成したリソースを確認 「リソース」タブから確認する 42 ❹ ClouldShellでCDK体験 詳細手順 フラットビューが、 一覧性が高くオススメ 2XXX.XX.XX XX:XX:XX UTC+0900 2XXX.XX.XX XX:XX:XX UTC+0900
43. 作成されたリソースを見てみる1 43 ❹ ClouldShellでCDK体験 詳細手順 CDKに記述した通り、 SNSトピックが作成されている arn:aws:sns:xx https://sqs.xx CDKに記述した通り、 SQSキューが作成されている
44. 作成されたリソースを見てみる2 44 ❹ ClouldShellでCDK体験 詳細手順 CDKに記述した通り、 SNSサブスクリプションが作成されている arn:aws:sns:xx
45. 45 ❹ ClouldShellでCDK体験 詳細手順 無事、AWSリソースを、CDKを用いて、コードで作成(IaC)することに 成功しました！ 最後に、トライアルで作成したAWSリソース、スタックを削除して、 CDK体験を終わらせましょう
46. １）スタックCdkWorkshopStackの削除 46 ❹ ClouldShellでCDK体験 詳細手順 削除方法_スタックCdkWorkshopStack関連 2XXX.XX.XX XX:XX:XX UTC+0900 2XXX.XX.XX XX:XX:XX UTC+0900
47. 47 ❹ ClouldShellでCDK体験 詳細手順 スタックCdkWorkshopStackと紐付いたリソースが削除されたことを確認 「〇〇の属性を取得できませ んでした。」の表示で、 リソース削除済みを確認する 2XXX.XX.XX XX 2XXX.XX.XX XX:XX:XX UTC+0900 arn:aws:sns :xx arn:aws:sns: xx
48. １）スタックCDKToolkitにより作成されたS3バケットに、 cdk deployすることで作成されたjsonファイルの削除 48 ❹ ClouldShellでCDK体験 詳細手順 削除方法_スタックCDKToolkit関連 S3バケットと、その中のファイルは、 「スタックを削除しても一括削除されない」た め、 個別に削除作業が必要！ 2XXX. XX. XX XX: XX: XX UTC+0900 2XXX. XX. XX XX: XX: XX UTC+0900 cdk-xx 2XXX. XX. XX XX: XX: XX UTC+0900 xxx.json
49. ２）スタックCDKToolkit内のS3バケットの削除1 49 ❹ ClouldShellでCDK体験 詳細手順 削除方法_スタックCDKToolkit関連 2XXX. XX. XX XX: XX: XX UTC+0900 2XXX. XX. XX XX: XX: XX UTC+0900
50. ３）スタックCDKToolkit内のS3バケットの削除2 50 ❹ ClouldShellでCDK体験 詳細手順 削除方法_スタックCDKToolkit関連 対象S3バケットが正常に削除されたことを確認する
51. ４）スタックCDKToolkitの削除1 51 ❹ ClouldShellでCDK体験 詳細手順 削除方法_スタックCDKToolkit関連 2XXX.XX.XX XX:XX:XX UTC+0900
52. ５）スタックCDKToolkitの削除2 52 ❹ ClouldShellでCDK体験 詳細手順 削除方法_スタックCDKToolkit関連 DELETE_SKIPPEDとなっているS3バケットが、（手動で）削除済みであることを確認する 2XXX.XX.XX XX:XX:XX UTC+0900 2XXX.XX.XX XX:XX:XX UTC+0900 cdk-
53. 53 ❹ ClouldShellでCDK体験 詳細手順 無事、AWSリソースを、CDKを用いて、コードで作成(IaC)することに 成功し、トライアルで作成したリソースの削除も完了しました。 お疲れ様でした！
54. 54 参考：ClouldShellでCDK体験 発生費用について → ほぼ発生なし 使うツール 課金のされ方・今回課金 Cloudshell 無料で利用可能、ただし月間使用量制限あり。CloudShellを通じて使用する他のAWSリソースやデータ転送に は、通常のAWS料金が適用される。 今回は、CloudShellを通じて使用する他のAWSリソースにつき「作成されるリソース」以下で検討。 CloudFormation CloudFormation自体の利用料金は発生しないが、作成したAWSリソースに対して料金が発生。 AWSとAlexaに関するリソース以外のサードパーティーサービスをテンプレートに含める場合には料金が発生。 今回はAWSリソース作成のため課金されない。 作成されるリソース 課金のされ方・今回課金 cdk boostrapコマンド実行 CDKを開始するために必要なAWSリソースが作成される。 SSM パラメータストア 標準パラメータは無料。高度なパラメータを使用する場合、1万回のAPI呼び出しごとに$0.05。 今回は標準パラメータに設定をしたので、課金されない。 ECRリポジトリ 保存するデータとインターネットに転送するデータの量に対して課金される。 今回はデータを保存していないので課金されない。 S3バケット ストレージ利用量、リクエスト回数、データ転送に課金される。 今回はcdk deploy時にファイルが自動生成され保存されたので、わずかに課金される。 S3バケットポリシー S3バケットポリシーには課金されない。 今回は課金されない。 IAM Role IAMユーザー・グループ・ロールの作成と管理は、無料で利用できる。 今回は課金されない。 IAM Policy IAM ポリシーによるアクセス権限の制御は、無料で利用できる。 今回は課金されない。 cdk deployコマンド実行 CDK tsファイルに定義したAWSリソースが作成される。 SQSキュー 毎月最初の100万リクエストは無料。 今回は月100万リクエストを超えないため課金されない。 SNSサブスクリプション サブスクリプションに登録されているエンドポイントにメッセージを送信する際に課金。 今回はメッセージを送信していないため課金されない。 SNSトピック トピックとして定義され使用した分に課金。(1カ月に作成された API リクエストの数、および、複数のエンドポ イントに対する配信の回数に基づく) 今回はトピックを定義したが使用（配信）していないので課金されない。