Kubernetes Code Contribution入門

Kubernetes Novice Tokyo #32 で登壇したセッションの資料です。
https://k8s-novice-jp.connpass.com/event/317561/

配信URL:
https://www.youtube.com/live/sRLG9ufaZ4M

Transcript

1. Kubernetes Code Contribution 入門 〜 K 8 sにコードコントリビューションをしよう！ 〜 Kubernetes Novice Tokyo # 3 2 ( 2 0 2 4 / 5 / 2 1 ) @bells 1 7
2. ▶ @bells 1 7 ▶ Software Engineer@ 3 -shake inc. ▶ kubernetes & kubernetes-csi member ▶ Kubernetes SIG-Docs ja localization reviewer ▶ Kubernetes Internal Organizer ▶ Kubernetes Novice Tokyo Organizer ▶ #kubenews ▶ X(Twitter): @bells 1 7 _ ▶ GitHub: @bells 1 7
3. Kubernetesへのコントリビューション 方 法を考える
4. Kubernetesへのコントリビューション ▶ Stack Over fl ow/SlackなどでKubernetesに関する質問に答える ▶ 何かしらのバグに遭遇したらissueを 立 ててみる ▶ ドキュメントを書く/翻訳する ▶ コードを書いてPRを作る/PRをレビューする ▶ etc …
5. Kubernetesへのコントリビューション ▶ Stack Over fl ow/SlackなどでKubernetesに関する質問に答える ▶ 何かしらのバグに遭遇したらissueを 立 ててみる ▶ ドキュメントを書く/翻訳する ▶ コードを書いてPRを作る/PRをレビューする ▶ etc … まず先にこのあたりを見てきましょう
6. Stack Over fl ow/Slackなどで Kubernetesに関する質問に答える
7. Stack Over fl owで質問に答える
8. Kubernetes Slackで質問に答える
9. Stack Over fl ow/Slackなどで Kubernetesに関する質問に答える ▶ こんな経験が積める + 自 分の知識の整理と理解を深めるきっかけになる (質問にちゃんと答えるために確認してから答えたりする) + Kubernetesに関するいろんな知 見 を深めるきっかけになる → 自 分が知らないことでも「ちょっと 見 てみるか〜」という 気分でやってみたり
10. 何かしらのバグに遭遇したらissueを 立 ててみる
11. kubernetes-csi/external-provisionerの例
12. kubernetes/prowの例
13. 何かしらのバグに遭遇したら issueを 立 ててみる ▶ こんな経験が積める + issueを 立 てるためにちょっとコードを読んでみたり、 いつもより深い動作確認でテストしてみたりして普段とは違う経験を するきっかけになる + 自 分の 立 てたissueに対して実際にPRが作られたりするのは結構楽しい (OSS開発に参加した気分を感じられる) + 次は 自 分でPR作ってみようかな〜という気持ちにさせてくれる
14. ドキュメントを書く/翻訳する
15. ドキュメントを書く/翻訳する よく考えたら新規のドキュメント書いたことなかった…
16. ドキュメント翻訳に関するissueを 立 てたり
17. ドキュメント翻訳のPRを作ったり
18. 他の 方 のPRをレビューしたり
19. ドキュメントを書く/翻訳する ▶ こんな経験が積める + 翻訳/レビューするにあたって英語ドキュメントをしっかり 読むことになるので、Kubernetesのいろんな機能について ちゃんと勉強するきっかけになる (場合によっては対象機能の動作確認などをして確認したり) + 直接PRを作って翻訳活動に参加できるので、OSSにダイレクトに 貢献できる + KubernetesのOSSサイクルやCIツール(prow)などについて学べる + 英語に触れるきっかけになる (ちなみに僕は英語苦 手 )
20. 翻訳活動の詳しいことは下記の資料をみてください！ https://speakerdeck.com/nasa 9 0 8 4 /kubernetes-sig-docs-localization-subproject-ja
21. コードを書いてPRを作る/PRをレビューする 今日はこれが本題!
22. Kubernetes Code Contributionの 基本的な流れ ▶ 取り組むissueを 立 てる/ 見 つける (新規機能の場合はKEPを作り承認を得る) ▶ 実装にあたって必要なことを調べる ▶ 実装してPRを作成 ▶ レビューしてもらってlgtm/approveをもらう ▶ mergeされる
23. 新規機能開発はKEP承認などが必要でハードルが 高 い こういうなっがいProposalを書いて承認をもらう必要がある
24. good fi rst issue/help wantedは難易度が 高 いのもそこそこ多い issueの中身見ると「初心者には何をやっていいかわからん」ってなるの多い
25. Kubernetes本体以外のリポジトリだと割とやりやすいのが多い まずコードベースが圧倒的に小さいのでコードに手を加えやすい
26. Deprecated対応みたいなやつも 手 を出しやすい エディタ開いてWarning出るやつを片っ端から直してくだけ
27. GitHub Projectからissueを探すのも良さそう
28. 開発環境改善系もちょくちょくissueが 見 つかる Linuxでは動くけどMacだとうまく動かん！みたいなやつがちょいちょい
29. Contextual Logging周りはマジで 人足 りてない 地味な系だからかこれメインであんまり作業してくれる人少ないのかもしれん
30. PRとか作ってたりするとたまにバグっぽいのも 見 つける これはKubernetes本体じゃなくてCIツールのprowのissueだけど
31. たまにはKEPいらなさそうなfeature系のPR作ってみたり これは元PRがあったけど止まってたので引き継いで新しいPR出してみた例
32. 時にはレビュー依頼されてlgtmしたり
33. ちなみに英語でのやり取りは下記を使えば 割となんとかなる ▶ 生 成AI: ChatGPT, Claudeなど ▶ 翻訳ツール: Google翻訳, DeepLなど ▶ その他: Grammarlyなど 英語苦 手 なのでこれらのツールに頼りまくってます
34. 実装にあたって必要なことを調べる
35. 例えばContextual Loggingとかだとドキュメントがあるので読む
36. 後は関連しそうなPRを読んだり
37. 中には1からコードを読むしか無いのもある
38. レビューしてもらってlgtm/approveをもらう
39. 各approverからapproveをもらう ▶ Kubernetesでは各ディレクトリ毎にOWNER ファイルが設置してあり、approveできる 権限者が設定されている ▶ PRでは、変更内容に応じて各approverから approveをもらう必要がある (GitHubで 言 うCODEOWNERSみたいなやつ) ↓ そのためPRはできるだけ単 一 のapproverに 閉じる形で 小 さいPRにしたほうが マージまでがスムーズ
40. 変更範囲が多いとこんな感じになる /assign の人たち全員からapproveしてもらう必要があって大変
41. マージされるとSlackで褒められるくらい調整作業は 大 変みたい
42. まとめ
43. まとめ ▶ 今だと例えばDeprecated対応やContextual Logging対応などが取り組み始めやすい Kubernetesに対するコードコントリビューションかなと思います ▶ Kubernetes本体以外のsigsやcsiなどは開発者が 足 りてないリポジトリも多いので、 そのあたりだとfeature系の開発も取り組みやすくて良いと思います ▶ 実際に「コントリビュートしたいけどネタが 見 つからない」って 人 はDMなどで ご連絡ください！ ▶ また、公式ドキュメントに対する翻訳活動も 人 が少ないので、活動に参加してくださる 方 をお待ちしています！
44. 公式が出してるオンボーディング資料もあります https://www.kubernetes.dev/docs/onboarding/
45. コントリビューションのための zenn scrapを作ってるので 興味があれば 見 てみてください https://zenn.dev/bells 1 7 /scraps/df 5 9 9 c 3 e 9 5 e 8 2 6 ▶ コントリビューションにあたって 目 を通すもの ▶ 知っておくと便利なツール ▶ テストなどの実 行方 法 などなどコントリビューションに役 立 つかも しれない情報をメモしています!
46. 参考資料 ▶ https://speakerdeck.com/nasa 9 0 8 4 /kubernetes-sig-docs-localization-subproject-ja ▶ https://github.com/kubernetes/kubernetes ▶ https://www.kubernetes.dev/docs/ ▶ https://github.com/kubernetes/community/blob/master/contributors/devel/ development.md?plain= 0 ▶ https://zenn.dev/bells 1 7 /scraps/df 5 9 9 c 3 e 9 5 e 8 2 6
47. 画像引 用 元 ▶ https://github.com/kubernetes/community/tree/master/icons ▶ https://github.com/kubernetes/kubernetes/tree/master/logo ▶ https://github.com/cncf/artwork/tree/master/projects/kubernetes ▶ https://github.com/kubernetes/kubeadm/tree/main/logos
48. Thanks / Question? ▶ @bells 1 7 ▶ Slide: https://speakerdeck.com/bells 1 7 ▶ @bells 1 7 _