Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
初心者でもできる! AWS CDKへのコントリビュート
Search
bun
July 24, 2023
Technology
0
930
初心者でもできる! AWS CDKへのコントリビュート
DevelopersIO 2023 福岡 にて登壇させていただいた時の資料となります。
bun
July 24, 2023
Tweet
Share
More Decks by bun
See All by bun
とあるOSSを継続可能にするための取り組みについて / OSS Refactoring Process
bun913
2
290
そのbeforeEach本当に必要? TIPSをご紹介 / beforeEach TIPS
bun913
1
200
あなたはどっち派?XSpec系テストフレームワークの構造化流派について / XSpec Title Naming
bun913
1
380
良いユニットテストの性質を整理してたら考えるべき設計も見えてきたの
bun913
11
6.3k
GitHub Copilotと快適なユニットテストコード作成生活
bun913
10
6k
気が付いたらJSTQB AL TAに合格していた。そんな旅がしたいの。
bun913
2
560
ユーザーストーリーのレビューを自動化したみたの
bun913
1
760
「XX試験の環境作ってよ」と言われた時によく使うAWSのソリューションについて
bun913
0
280
出社っていいものなの。開発者のテストに対する疑問や思いが聞けたの
bun913
0
700
Other Decks in Technology
See All in Technology
エンジニア向け会社紹介資料
caddi_eng
14
270k
とある事業会社にとっての Kaggler の魅力
hakubishin3
7
1.5k
フェンリルの SwiftUI の研修を覗いてみる / Fenrir SwiftUI Training
studio_rookery
0
130
外部カンファレンスで登壇しよう! 〜「強い」エンジニアへの一歩を踏み出す〜
logica0419
4
130
VueとViteで作るUIコンポーネントライブラリ ~デザインシステムとプロダクトの理想的な分離を目指して~ / 20241019_cloudsign_VueFesJapan2024_1
bengo4com
8
3k
Covariance, Contravariance & Diamond
alexdaubois
1
110
今日から始める技術的負債の解消
leveragestech
3
440
組織デバイスのための効率的なアプリケーション更新戦略
kenchan0130
0
450
いまいまMySQL2024 @ OSC Nagaoka
sakaik
3
270
プログラミング写経のすすめ
natsutan
0
150
複数の外部サービスデータの統合と変換を実現する Railsのインポートアーキテクチャ / Rails import architecture for integration and transformation of multiple external service data
aiandrox
0
190
【完全版】Dify - LINE Bot連携 考え方と実用テクニック
uezo
3
850
Featured
See All Featured
A Tale of Four Properties
chriscoyier
156
22k
Building Adaptive Systems
keathley
38
2.2k
Fashionably flexible responsive web design (full day workshop)
malarkey
404
65k
Product Roadmaps are Hard
iamctodd
PRO
48
10k
Designing for Performance
lara
604
68k
Reflections from 52 weeks, 52 projects
jeffersonlam
346
20k
Six Lessons from altMBA
skipperchong
26
3.4k
The Cult of Friendly URLs
andyhume
77
6k
How to Ace a Technical Interview
jacobian
275
23k
Done Done
chrislema
181
16k
Happy Clients
brianwarren
97
6.7k
Keith and Marios Guide to Fast Websites
keithpitt
408
22k
Transcript
初心者でもできる! AWS CDKへのコントリビュート 2023/7/24 AWS事業本部 モダンアプリケーションコンサルティング部 今泉大樹 1
#devio2023 2
本セッションではAWS CDKという ツールについてお話しします 3
注意事項 •AWSサービスについてのお話しはほとんどありません •AWS CDKの具体的な使い方は紹介いたしません •「俺(私)・・・今年こそOSS貢献するんだ・・・」という方に向けたお話しを いたします 4
自己紹介 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年前くらいからの趣味: ◯◯の大冒険
Agenda •AWS CDKってなに? •初めてAWS CDKを使うときのオススメ •AWS CDKへのコントリビューション(貢献)と方法 •コントリビューションをするときの注意点 6
7 AWS CDKってなに?
ようするに IaC(Infrastructure as Code) のツールの一つです 8
こんな構成を作るときに 9
AWS CDKならこれだけの記述量です 10
公式サイトを見てみましょう 11
さまざまなプログラミング言語で利用可 12
13 初めてAWS CDKを使うときのオススメ
いろいろな言語でCDKを使えるとなると じゃあPythonやGoなら知っているから それで触ってみようかな? 14
親しんだ言語で開始するのもいいのですが TypeScriptで開始するのがおすすめです 15
私がTSをおスメする理由 AWS CDKが様々な言語で利用できる仕組みと関 係しています 16
JSiiという仕組み 17 TypeScriptで書かれたプロジェクトが JavaScript、Python、Java、C#などでも利用 できる
TypeScriptで書かれたソースをJSiiで変換 18 (ほとんどの)CDKのソースコードはTSで記述 されている
•AWS CDKで検索するとTypeScriptの情報が多く出てくる •TSは静的型付言語なので、型の恩恵を受けることができる • ちょっとしたパラメーターなら調べるより型見た方が早い • 「インフラリソースの定義」という性質上パラメーターが多い •これらに加えて・・・ ということで理由です 19
普段のCDK開発から型の定義やメソッドの定義をよく見る →普段から定義をよく見るようになると構造を理解しやすい →構造を理解すると当然バグの直し方や原因を把握しやすい →コントリビューション(貢献)のチャンス!! ソースコードがTypeScriptということは!? 20
21 AWS CDKへのコントリビューション (貢献)と方法
おさらいも兼ねて AWS CDKへのコントリビューションはTypeScript で書かれるリポジトリのみでOK 22
GitHubにリポジトリがあります 23 https://github.com/aws/aws-cdk
コントリビューションの流れ 24
一般的な開発と同じ流れなのはわかった どうやってIssueとか見つけるの? バグなんて自分では中々見つけられないでしょ 25
まずはGitHubのリポジトリにアクセス 26 https://github.com/aws/aws-cdk
IssuesでIssueの一覧を開く 27 https://github.com/aws/aws-cdk/issues
good first Issueのラベルでフィルタリング 28
(ドキュメント修正の場合) 29 「documentation」のラベルを追加
(軽微なバグ修正の場合) 30 「bug」のラベルを追加
ほぼ答えが書かれているIssueも 31 コアコントリビューターの方が 「どこの」「なにを」直せば良さそうかアドバイス をしている
実際に私が担当したバグ 32 クラス初期化時に受け取ったパラメーターをリ ソース作成時に渡し忘れるバグ お茶目なミスもカワイイですね
これでIssue探しはばっちり ローカルで開発するときの注意点もいくつか 紹介します 33
34 コントリビューションをするときの注意点 (3点)
注意点1 ビルドもサクッと通らない可能性があります 35
AWS CDKのリポジトリはモノレポ 36 aws-cdk-libというパッケージの中にもCDKで 対応する様々なサービスが・・・
aws-cdk-lib というパッケージをビルド 37 lernaというモノレポ管理に利用されるツールを 利用している ※ このビルドにも数分要する https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md
ビルド時にメモリが足らないことも・・・ 38
それですらコントリビューションのチャンス 39 https://github.com/aws/aws-cdk/pull/26465/files 1行追加しただけですが、新規コントリビュー ターの無駄時間を削る貢献です
注意点2 開発時はこまめに単体テストを実施する 40
修正って怖いですよね?でもありがたいことに AWS CDKはかなりテストが書かれている 41
aws-cdk-libだけでもテストに時間がかかる 42 修正した部分だけ単体テストを実行する方法も 書かれています https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md
注意点3 実際にリソースを作成するテストでは 課金に注意 43
Integration Testの課金 44 https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md 実際にリソースを作成する挙動をする
AWS Configの変更の検知には留意 45 https://dev.classmethod.jp/articles/aws-config-amazon-athena/
手っ取り早いのは CDK検証用のアカウント用意した方が良いかも 46
どうしても課金がいやなら 47 代わりにIntegテストを実行してくれたコアコント リビューターの方もいらっしゃいました
48 まとめ
•AWS CDKはIaCの一種でいろいろなプログラミング言語で書ける •TypeScriptで始めるのがおすすめ •初めてのコントリビューションには`good first issue` を探す •課金発生するポイントを抑えて楽しく開発しましょう まとめ 49
50