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
750
初心者でもできる! AWS CDKへのコントリビュート
DevelopersIO 2023 福岡 にて登壇させていただいた時の資料となります。
bun
July 24, 2023
Tweet
Share
More Decks by bun
See All by bun
ユーザーストーリーのレビューを自動化したみたの
bun913
1
460
「XX試験の環境作ってよ」と言われた時によく使うAWSのソリューションについて
bun913
0
150
出社っていいものなの。開発者のテストに対する疑問や思いが聞けたの
bun913
0
550
JSTQB AL TM試験に 開発者が合格したので勉強法を共有するの
bun913
0
1k
なんちゃってスクラムのテストに悩んでいた時の自分へ伝えたいの
bun913
0
760
RDBを使う単体テストの前に 用意しておきたい環境を考え てみたの
bun913
0
550
非機能テストのシフトレフト(あれ?テストを自動化したけど何か足りない?)
bun913
1
860
AWSに関するOSS活動で得た貢献までの壁を越えるコツ
bun913
0
720
周りが強すぎて現実逃避でOSS活動始めた結果
bun913
0
620
Other Decks in Technology
See All in Technology
MixIT 2024 - Pulumi : Gérer son infra avec son langage de programmation préféré
ju_hnny5
1
120
生成AIの変革の時代に、直近1年で直面した課題とその解決策
ktc_wada
0
690
コードファーストの考え方。 Amplify Gen2から学ぶAWS次世代のWeb開発体験
yoshiitaka
2
370
M5stackで使用できるpHセンサの開発
shinrinakamura
0
200
止まらないLinuxシステムを構築する_高信頼性クラスタ入門
koedoyoshida
2
460
地理空間データ可視化・解析・活用ソリューション Pacific Spatial Solutions (PSS)
pacificspatialsolutions
0
340
EMとして2023年度に頑張ったこと / What we did well in FY2023 as a EM
pauli
1
260
Cracking the KubeCon CfP
inductor
2
270
いいたいことちゃんという
tkengo
0
240
【SORACOM UG 東海】あらゆるモノがつながる社会へ、IoT と SORACOM
soracom
PRO
1
150
ルーターでプレゼンする
puhitaku
1
3.3k
Autonomous Database Cloud 技術詳細 / adb-s_technical_detail_jp
oracle4engineer
PRO
15
35k
Featured
See All Featured
Templates, Plugins, & Blocks: Oh My! Creating the theme that thinks of everything
marktimemedia
20
1.8k
Building Applications with DynamoDB
mza
88
5.6k
Making the Leap to Tech Lead
cromwellryan
125
8.5k
The Psychology of Web Performance [Beyond Tellerrand 2023]
tammyeverts
14
1.6k
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
eileencodes
126
32k
10 Git Anti Patterns You Should be Aware of
lemiorhan
649
58k
Imperfection Machines: The Place of Print at Facebook
scottboms
261
12k
Fashionably flexible responsive web design (full day workshop)
malarkey
398
65k
5 minutes of I Can Smell Your CMS
philhawksworth
199
19k
Designing Experiences People Love
moore
136
23k
Responsive Adventures: Dirty Tricks From The Dark Corners of Front-End
smashingmag
245
20k
Designing Dashboards & Data Visualisations in Web Apps
destraynor
226
51k
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