異次元のCloudFormation 拡張コマンド～Rain～

Hibiya.Tech #5「愛情爆発！わたしの推し技術を語りたい」にてお話しした内容になります。
https://classmethod.connpass.com/event/316770/

Transcript

1. Hibiya.Tech #5 異次元のCloudFormation 拡張コマンド～Rain～ 2024-05-24
2. 自己紹介 渡邉 洋平(watany) • NTTテクノクロス株式会社 • JAWS-UG東京 運営 • Japan AWS Top Engineer 2023
3. CloudFormation運用をめぐる状況は厳しく • AWS CDKでラップして使う • AWS SAM派の人はわかる • 素で使うのは負け ※個人の見解です
4. Rainがいるぜ
5. Rain • CloudFormation（以下CFn）のテンプレート、スタックを管理するCLIツール • 公式RepositoryでOSSの形で提供されている • 現状も開発が継続されている(重要) https://github.com/aws-cloudformation/rain
6. CFnそのままだと何が困るか CFnの見直し理由 1. Templateを書きづらい • SupersetのCDKやSAMで解決する? • とはいえ既存資材がCFnのことはある。 • 生成AIの支援があれば、CFnで十分作れることも 2. Stackを運用しづらい • CDKやSAMでもよいが、この点ならRainで解決できる つまり、CFn運用へのペインを解決したいだけならRainが役に立つ
7. Rainの実例 CFnテンプレートのCRUD操作を例に紹介します 1. Create 2. Read 3. Update 4. Delete
8. 1. Create
9. １．Create with AWS CLI • 作ったら非同期でStackIdだけが返却される。 ◦ 今の状態は？ 失敗したら？
10. １．Create with Rain • 変更セットを表示し、y/nでデプロイ前確認がある • デプロイ中の状況をコンソールに出力される • 不正なテンプレートなら、ロールバックまでを表示
11. １．Create with Rain • OKテイク
12. 2. Read
13. ２．Read with AWS CLI • Stackの状況(StackName/StackStatus)を知りたい ◦ CLIの場合はjqを組み合わせると便利
14. ２．Read with Rain • rainは同等の操作が簡単 • 「rain ls <stack-name>」でスタックの状況確認 ◦ 「rain ls」でRegion内のスタック一覧、「rain ls -a」で全Region
15. ２．Read with Rain • 「rain cat <stack-name>」でスタックの詳細確認
16. 3. Update
17. ３．Update with AWS CLI • Createと別のコマンド、Createと同じ問題 • > 作ったら非同期でStackIdだけが返却される。 ◦ > 今の状態は？ 失敗したら？
18. ３．Update with Rain • Createと同じ`rain deploy`でUpdate可能！(CDK相当)
19. 4. Delete
20. ４．Delete with AWS CLI • Deleteすると結果が標準出力されない(?!) ◦ 今の状態は？ 失敗したら？
21. 4．Delete with Rain • rain rm <stack>で「スタックの状態」「削除状況」「削除成否」を表示 ◦ 驚き最小限の挙動
22. いかがでしたか？ • ここまでのまとめ ◦ CloudFormation APIの非同期性をRainが吸収してくれる ◦ コマンドも直観的。Linuxユーザなら扱いやすい。 • 想定問答 ◦ これってAWS CDK CLIでも同様なのでは？ ▪ はい。ただ、他にも色々できます。 ▪ CDKユーザも以降の機能のためにrainを入れた方がいいです。
23. 5. CRUD以外にできること
24. Build
25. rain build • CFnテンプレートのひな型を作るためのコマンド • 例: うろ覚えでAPIDestinationを作る場合、 ◦ 公式ドキュメント無しでも「--list」で探して……
26. rain build • rain buildの引数に入れると、ひな型が出てくる！
27. rain build • -b(bare)を指定すると、必要最小限のひな型に
28. Logs
29. rain logs • Stackのイベントを人間が読みやすい形式にスッと出せる。 ◦ 「aws cloudformation describe-stack-events」はevent毎に10行くらいあるので読みづ らい。 ◦ マネジメントコンソールで見たい理由の半分 (私見)が解決
30. rain logs • CREATE_FAILEDの経緯も抜粋して表示。 ◦ logs –allで全表示できる
31. Tree
32. rain tree • CFn Templateの構造を表示してくれる
33. rain tree • dot形式も対応しているので、認知負荷をさらに減らせる
34. いかがでしたか？ (2回目) • ここまでのまとめ ◦ RainはCRUD操作だけでなく、CFn Stackの運用に役立つ機能をCUIで提供。 ◦ 慣れるとGUでの参照より、CloudShell＋Rainが快適になる！ • この辺の詳しい解説はカックさんの Blogも詳しい https://kakakakakku.hatenablog.com/entry/2023/05/05/110658
35. 6. も～っと！CRUD以外にできること
36. Stackset
37. rain stackset <deploy / ls / rm> • rain stackset でStackSetのCRUD操作が可能に！ ◦ こちらの素のAWS CLI叩くの不便なのでありがたい。。。
38. Forecast
39. rain forecast (Experimental) • 実際のStack作成前に、失敗を予測する機能 ◦ Not Linter (rain fmtはTemplateのFormatter) • 例：作成するBucket名被りを事前にチェック
40. • 現状は開発中。ロードマップの例 ◦ EIP制限のチェック ◦ EC2 Instance Typeが指定したAZで利用可能か？ ◦ VPC FlowlogsのFormatエラー ◦ etc… • ロードマップはGithub ◦ https://github.com/aws-cloudformation/rain/tree/main/internal/cmd/forecast rain forecast (Experimental)
41. Build + Claude3
42. • rain build…ひな型に値埋めてほしいな。 • 生成AIってやつで何とかならんか？ → なる。 ◦ --model, --prompt で指定する。 rain build + Generative AI
43. • こういうのが作れる ◦ ちなみにHaikuで作ると 上手く動かない … rain build + Generative AI
44. • Opusで解決だ！ ◦ わたしが追加しました rain build + Generative AI https://github.com/aws-cloudformation/rain/pull/374
45. まとめ • RainはCFnユーザ(SAM/CDK含む) 必須のツールである ◦ 悩んだら導入するくらいで良い • いまだに機能開発されて、まだまだ成長している • 2024年もRainを使ってこ ◦ https://github.com/aws-cloudformation/rain