初心者でもできる！ AWS CDKへのコントリビュート

DevelopersIO 2023 福岡　にて登壇させていただいた時の資料となります。

Transcript

1. 初心者でもできる！ AWS CDKへのコントリビュート 2023/7/24 AWS事業本部 モダンアプリケーションコンサルティング部 今泉大樹 1
2. #devio2023 2
3. 本セッションではAWS CDKという ツールについてお話しします 3
4. 注意事項 •AWSサービスについてのお話しはほとんどありません •AWS CDKの具体的な使い方は紹介いたしません •「俺（私）・・・今年こそOSS貢献するんだ・・・」という方に向けたお話しを いたします 4
5. 自己紹介 5 今泉 大樹 - bun913 クラスメソッド株式会社 AWS事業本部モダンアプリケーションコンサルティング部 Twitter: @bun76235104 GitHub: bun913 4年半ほどITエンジニアをしています (3年Webアプリ寄り、1年半程度AWSインフラ寄り） 2023年7月よりお客様のアプリのモダナイズをご支援 2023 Japan AWS Top Engineer 2023 Japan AWS All Certifications Engineer 最近の趣味: 競技プログラミング（そんなに強くない） 25年前くらいからの趣味: ◯◯の大冒険
6. Agenda •AWS CDKってなに？ •初めてAWS CDKを使うときのオススメ •AWS CDKへのコントリビューション（貢献）と方法 •コントリビューションをするときの注意点 6
7. 7 AWS CDKってなに？
8. ようするに IaC（Infrastructure as Code） のツールの一つです 8
9. こんな構成を作るときに 9
10. AWS CDKならこれだけの記述量です 10
11. 公式サイトを見てみましょう 11
12. さまざまなプログラミング言語で利用可 12
13. 13 初めてAWS CDKを使うときのオススメ
14. いろいろな言語でCDKを使えるとなると じゃあPythonやGoなら知っているから それで触ってみようかな？ 14
15. 親しんだ言語で開始するのもいいのですが TypeScriptで開始するのがおすすめです 15
16. 私がTSをおスメする理由 AWS CDKが様々な言語で利用できる仕組みと関 係しています 16
17. JSiiという仕組み 17 TypeScriptで書かれたプロジェクトが JavaScript、Python、Java、C#などでも利用 できる
18. TypeScriptで書かれたソースをJSiiで変換 18 （ほとんどの）CDKのソースコードはTSで記述 されている
19. •AWS CDKで検索するとTypeScriptの情報が多く出てくる •TSは静的型付言語なので、型の恩恵を受けることができる • ちょっとしたパラメーターなら調べるより型見た方が早い • 「インフラリソースの定義」という性質上パラメーターが多い •これらに加えて・・・ ということで理由です 19
20. 普段のCDK開発から型の定義やメソッドの定義をよく見る →普段から定義をよく見るようになると構造を理解しやすい →構造を理解すると当然バグの直し方や原因を把握しやすい →コントリビューション（貢献）のチャンス！！ ソースコードがTypeScriptということは！？ 20
21. 21 AWS CDKへのコントリビューション （貢献）と方法
22. おさらいも兼ねて AWS CDKへのコントリビューションはTypeScript で書かれるリポジトリのみでOK 22
23. GitHubにリポジトリがあります 23 https://github.com/aws/aws-cdk
24. コントリビューションの流れ 24
25. 一般的な開発と同じ流れなのはわかった どうやってIssueとか見つけるの？ バグなんて自分では中々見つけられないでしょ 25
26. まずはGitHubのリポジトリにアクセス 26 https://github.com/aws/aws-cdk
27. IssuesでIssueの一覧を開く 27 https://github.com/aws/aws-cdk/issues
28. good first Issueのラベルでフィルタリング 28
29. （ドキュメント修正の場合） 29 「documentation」のラベルを追加
30. （軽微なバグ修正の場合） 30 「bug」のラベルを追加
31. ほぼ答えが書かれているIssueも 31 コアコントリビューターの方が 「どこの」「なにを」直せば良さそうかアドバイス をしている
32. 実際に私が担当したバグ 32 クラス初期化時に受け取ったパラメーターをリ ソース作成時に渡し忘れるバグ お茶目なミスもカワイイですね
33. これでIssue探しはばっちり ローカルで開発するときの注意点もいくつか 紹介します 33
34. 34 コントリビューションをするときの注意点 （3点）
35. 注意点1 ビルドもサクッと通らない可能性があります 35
36. AWS CDKのリポジトリはモノレポ 36 aws-cdk-libというパッケージの中にもCDKで 対応する様々なサービスが・・・
37. aws-cdk-lib というパッケージをビルド 37 lernaというモノレポ管理に利用されるツールを 利用している ※ このビルドにも数分要する https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md
38. ビルド時にメモリが足らないことも・・・ 38
39. それですらコントリビューションのチャンス 39 https://github.com/aws/aws-cdk/pull/26465/files 1行追加しただけですが、新規コントリビュー ターの無駄時間を削る貢献です
40. 注意点2 開発時はこまめに単体テストを実施する 40
41. 修正って怖いですよね？でもありがたいことに AWS CDKはかなりテストが書かれている 41
42. aws-cdk-libだけでもテストに時間がかかる 42 修正した部分だけ単体テストを実行する方法も 書かれています https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md
43. 注意点3 実際にリソースを作成するテストでは 課金に注意 43
44. Integration Testの課金 44 https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md 実際にリソースを作成する挙動をする
45. AWS Configの変更の検知には留意 45 https://dev.classmethod.jp/articles/aws-config-amazon-athena/
46. 手っ取り早いのは CDK検証用のアカウント用意した方が良いかも 46
47. どうしても課金がいやなら 47 代わりにIntegテストを実行してくれたコアコント リビューターの方もいらっしゃいました
48. 48 まとめ
49. •AWS CDKはIaCの一種でいろいろなプログラミング言語で書ける •TypeScriptで始めるのがおすすめ •初めてのコントリビューションには`good first issue` を探す •課金発生するポイントを抑えて楽しく開発しましょう まとめ 49