TL;DR

Kubernetesのコードを読んでみた感想を書きます。
公式ドキュメントではわからない細かい部分も確認します。

こちらはコードベースでk8sを理解することに努めていますが、
私の実力不足もあり、一部推論をしている箇所を含みます。

その箇所については、「思う」や「推察される」などの表現を用いています。
もし誤りや具体的な実装箇所をご存知の方がいらっしゃいましたら、
ご指摘いただけますと幸いです。

はじめに

Kubernetesは複雑なシステムですが、そのソースコードを読むことで公式ドキュメントだけでは理解しきれない内部動作を深く理解できます。

本記事では、Podのライフサイクルの中でも特にPodの終了処理に焦点を当て、実際のソースコードを追いながら以下の流れを解説します。

Pod削除要求 → kubelet → preStop Hook実行 → コンテナ停止

具体的には、以下のような疑問に対してコードベースで回答します。

ReplicaSetがPodを削除する際、内部的にどのような処理が行われるのか
kubeletはPodの削除要求をどのように検知し、処理するのか
preStop Hookはどのタイミングで、どのような仕組みで実行されるのか
API ServerからkubeletまでのPod削除の情報伝達経路はどうなっているのか

これらの疑問を、kubernetes/kubernetesリポジトリの実際のコードを参照しながら、一つずつ解き明かしていきます。コードを読み進める際は、まず全体の構造を把握してから、具体的な実装に入るアプローチを取ります。

想定読者

Kubernetesのコードに興味がある方
Kubernetesの内部動作を深く理解したい方

話すこと / 話さないこと

話すこと
- Kubernetesのコード構成
- 主要コンポーネントのコードリーディング
- 簡単な用語説明
話さないこと
- Kubernetesの基本概念
- Kubernetesの運用および開発

用語

コードリーディングをする際に最低限知っておくべき用語を説明します。普段からk8sの内部を意識されている場合は読み飛ばしても構いません。

Kubernetes Components | Kubernetesを参考にしています。

用語	説明
kubelet	Node上に一つ存在し、Podのライフサイクルを管理するエージェント。特にPodの起動、停止、コンテナランタイムとの連携（`preStop` Hook実行など）を担う。
API Server	Clusterに一つ存在し、KubernetesのAPIを提供するコンポーネント。すべてのリクエストはAPI Serverを通じて行われ、Clusterの状態を管理する。
Pod	Kubernetesの基本的なデプロイメントユニット。1つ以上のコンテナを含み、同じNode上で実行される。
kube-controller-manager	Cluster全体の状態を監視し、必要に応じてリソースの作成、更新、削除を行うコンポーネント。ReplicaSetやDeploymentなどのコントローラーが含まれる。
`preStop` Hook	Pod内のコンテナが終了する前に実行される特定のアクションを定義するためのフック。例えば、アプリケーションのシャットダウン処理などに使用される。

Kubernetesのコードはどこにあるのか？

KubernetesのコードはGitHub上で公開されています。
kubernetes/kubernetes: Production-Grade Container Scheduling and Management

kubernetes/kubernetes at c70011cf108c8af63c5b4af3c2f8ff88b333a698 のcommitを基準に説明します。

ディレクトリ構成について

次のディレクトリ構成を保持しています。

ディレクトリ名	ざっと私が見た感じの説明
api/	API定義や仕様が入っており、OpenAPIに関する内容および既存のAPIでOpenAPIから逸脱している部分の管理も行われています。
build/	buildの方法やリリースに関する内容が含まれています。
CHANGELOG/	変更履歴が記載されています。
cluster/	GCEとの統合やアドオンについて記載がある。ただ、新規のProviderがここへ将来的に追加されることはないようです。
cmd/	Kubernetesの各コンポーネントのエントリーポイントが含まれています（例: kubectl, kube-apiserverなど）。
docs/	空のディレクトリです。
hack/	開発のためのスクリプトやツールが含まれています。
logo/	あらゆるKubernetesのロゴが含まれています。
pkg/	主要なライブラリコードが含まれています。
plugin/	Admissionや認証、認可に関するプラグインが含まれています。
staging/	k8s.io以下のモジュールが含まれており、実態は他のリポジトリにあります。
test/	E2Eテストなどのテストコードが含まれています。
third_party/	QEMUやProtoBufなどのサードパーティコードが含まれています。
vendor/	依存関係のライブラリコードが含まれています。

コードを読み漁る

PodのLifecycle

今回はPodのLifecycleに関するコードを確認してみます。

PodのLifecycleについては、Pod Lifecycle | Kubernetesを見るとkubeletがPodの状態を管理していることがわかります。そのため、kubeletのコードを確認します。

pkg/kubelet/pod_workersにあるpodWorkersというPodに関するイベントを処理するstructがあります。
その中に、UpdatePodというPodの更新イベントを処理する関数があります。

UpdatePod
- podWorkerLoop

上記のものはinterfaceも提供されており、pkg/kubelet/kubelet.goのKubeletというkubeletの主要であるstructにある
syncLoopIterationという関数からSyncHandlerのHandlePod**系の関数から呼ばれていることを確認できます。

syncLoopIteration

よって UpdatePod関数がPodの状態を管理する主要な関数であることがわかります。

Podが終了する際の処理

Podがどのように終了するかを確認します。目標としてはpreStop Hookがどのように実行されるかを確認するところまでにします。

大まかなPodの終了の流れについては、以下の記事が参考になります。

@superbrothers さんの記事: Kubernetes: 詳解 Pods の終了 #kubernetes - Qiita
hhiroshell さんの記事: アルパカでもわかる安全なPodの終了

まず、Podに対してのOperationは6つ存在していて、終了をする場合はまず DELETE が走り、その後に REMOVE が走ることと伺えました。

https://pkg.go.dev/k8s.io/kubernetes/pkg/kubelet/types#PodOperation より

そのため、まずは DELETE の処理を確認します。この場合は HandlePodUpdatesが呼ばれていることがわかります。

該当コード: https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/kubelet.go#L2603-L2606

また、HandlePodUpdatesの中では管理配下にあるPodの状態についてmanagerに対して更新をかけ、最終的に workerに対してUpdatePod を呼び出しています。

該当コード: https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/kubelet.go#L2790-L2850

UpdatePodの中でIsTerminationRequestedがあるか確認されています。
これはPodSyncStatusのterminatingAtがnilでないかの内容です。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/pod_workers.go#L913

たとえば、DeletionTimestampについての設定のされ方としては、
pkg/controller/replicaset/replica_set.goのReplicasetの
manageReplicasの中でDeletePodが呼ばれた際に設定されていることがわかりました。

DeletionTimestampが設定される流れは少し複雑ですが、該当箇所を説明します。
今回はReplicaSetがPodを削除する場合を例に説明します。

この中で、r.KubeClient.CoreV1().Pods(namespace).Delete(ctx, podID, metav1.DeleteOptions{})が呼ばれています。
その中身は次の内容に紐付かれていて、REST APIのDELETEメソッドが呼ばれています。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/staging/src/k8s.io/client-go/gentype/type.go#L249-L259

URLの構成方法としては次の箇所にあります。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/staging/src/k8s.io/client-go/rest/request.go#L549-L583

今回の場合は、/api/v1/namespaces/{namespace}/pods/{name}の形になります。

また、APIサーバー側でURLパターンとハンドラーが登録されています。そして、ハンドラーとしてrestfulDeleteResourceが登録されています。

URLパターンの登録: https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/staging/src/k8s.io/apiserver/pkg/endpoints/installer.go#L539
ハンドラーの登録: https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/staging/src/k8s.io/apiserver/pkg/endpoints/installer.go#L963-L965

restfulDeleteResourceの実態はDeleteResourceにあります。

その中で特に重要な箇所がrest.GracefulDeleterによるDeleteの呼び出しです。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/staging/src/k8s.io/apiserver/pkg/endpoints/handlers/delete.go#L168-L172

こちらの実態はstore.goのDeleteにあり、ここでBeforeDeleteが呼ばれています。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/staging/src/k8s.io/apiserver/pkg/registry/generic/registry/store.go#L1129-L1220

こちらの中でsetDeletionTimestampが呼ばれており、DeletionTimestampが設定されます。

また、UpdatePodの中でpodWorkerLoopが呼ばれています（すでに起動している場合はスキップされます）。
こちらについては、実行だけして結果自体は待たない形になっています。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/pod_workers.go#L943-L972

podWorkerLoopでは単一のPodの状態を開始から終了まで管理しています。
その中でPodWorkerStateに応じて、SyncPodが呼ばれています。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/pod_workers.go#L1289-L1310

PodWorkerStateはSyncPodとTerminatingPod, TerminatedPodの3つの状態に分かれています。
おそらく、今回はTerminatingPodに遷移しているはずなので、その中身を確認します。

SyncTerminatingPodが上記のインターフェースの実装として呼ばれていると思われます。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/kubelet.go#L2173-L2290

この中で、killPodが呼ばれています。そのあとに、probeManagerに対してRemovePodが呼ばれています。
また、その前にlivenessの確認停止も行われています。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/kubelet.go#L2217-L2231

killPodの実態は下記にあります。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/kubelet_pods.go#L1035-L1048

具体的な内容としてはkubeGenericRuntimeManagerのKillPodが呼ばれています。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/kuberuntime/kuberuntime_manager.go#L1856-L1863

killPodWithSyncResultが呼ばれていて、更にその中でkillContainersWithSyncResultが呼ばれています。

killPodWithSyncResult: https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/kuberuntime/kuberuntime_manager.go#L1867-L1886
killContainersWithSyncResult: https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/kuberuntime/kuberuntime_container.go#L909-L946

さらにkillContainerが呼ばれていて、preStopが設定されている場合はexecutePreStopHookが呼ばれています。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/kuberuntime/kuberuntime_container.go#L839-L907

executePreStopHookはHookと同時にpreStopの完了を待っています。

https://github.com/kubernetes/kubernetes/blob/c70011cf108c8af63c5b4af3c2f8ff88b333a698/pkg/kubelet/kuberuntime/kuberuntime_container.go#L761-L789

感想

大規模なコードベースであるため、最初は全体像を把握するのが難しいと感じました。しかし、主要なコンポーネントやディレクトリ構成を理解することで、特定の機能に焦点を当ててコードを追跡することができました。
途中でREST APIの部分が出てきたため、Goのコードですべて閉じているわけではないため、他のロジックについて今後気になった際は、そちらの部分を気にして読めたらと思います。
こちらの箇所だけでも読み整理するのに半日程度かかったため、OSSのコードを読むことの難しさを改めて感じました。

今回はk8sのコードの内容を読み、一部抜粋して紹介をしたためライセンスについても記載します。
kubernetes/LICENSE at c70011cf108c8af63c5b4af3c2f8ff88b333a698 · kubernetes/kubernetes

                             Apache License
                       Version 2.0, January 2004
                    http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

  To apply the Apache License to your work, attach the following
  boilerplate notice, with the fields enclosed by brackets "[]"
  replaced with your own identifying information. (Don't include
  the brackets!)  The text should be enclosed in the appropriate
  comment syntax for the file format. We also recommend that a
  file or class name and description of purpose be included on the
  same "printed page" as the copyright notice for easier
  identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.