update at 2024-04-19 16:22:03

content/best-practices/graceful-shutdown/code-example-of-handle-sigterm.md

@@ -1,23 +0,0 @@
-# 业务代码处理 SIGTERM 信号
-
-要实现优雅终止，首先业务代码得支持下优雅终止的逻辑，在业务代码里面处理下 `SIGTERM` 信号，一般主要逻辑就是"排水"，即等待存量的任务或连接完全结束，再退出进程。
-
-本文给出各种语言的代码示例。
-
-<Tabs>
-  <TabItem value="shell" label="shell">
-    <FileBlock showLineNumbers file="handle-sigterm/sigterm.sh" />
-  </TabItem>
-
-  <TabItem value="python" label="Python">
-    <FileBlock showLineNumbers file="handle-sigterm/sigterm.py" />
-  </TabItem>
-
-  <TabItem value="js" label="NodeJS">
-    <FileBlock showLineNumbers file="handle-sigterm/sigterm.js" />
-  </TabItem>
-
-  <TabItem value="java" label="Java">
-    <FileBlock showLineNumbers file="handle-sigterm/sigterm.java" />
-  </TabItem>
-</Tabs>

content/best-practices/graceful-shutdown/sigterm.md

@@ -1,4 +1,56 @@
-# 在 SHELL 中传递信号
+# 正确处理 SIGTERM 信号
+
+## 业务代码处理 SIGTERM 信号
+
+要实现优雅终止，首先业务代码得支持下优雅终止的逻辑，在业务代码里面处理下 `SIGTERM` 信号，一般主要逻辑就是"排水"，即等待存量的任务或连接完全结束，再退出进程。
+
+本文给出各种语言的代码示例。
+
+<Tabs>
+  <TabItem value="shell" label="shell">
+    <FileBlock showLineNumbers file="handle-sigterm/sigterm.sh" />
+  </TabItem>
+
+  <TabItem value="python" label="Python">
+    <FileBlock showLineNumbers file="handle-sigterm/sigterm.py" />
+  </TabItem>
+
+  <TabItem value="js" label="NodeJS">
+    <FileBlock showLineNumbers file="handle-sigterm/sigterm.js" />
+  </TabItem>
+
+  <TabItem value="java" label="Java">
+    <FileBlock showLineNumbers file="handle-sigterm/sigterm.java" />
+  </TabItem>
+</Tabs>
+
+## 为什么程序收不到 SIGTERM 信号？
+
+我们的业务代码通常会捕捉 `SIGTERM` 信号，然后执行停止逻辑以实现优雅终止。在 Kubernetes 环境中，业务发版时经常会对 workload 进行滚动更新，当旧版本 Pod 被删除时，K8S 会对 Pod 中各个容器中的主进程发送 `SIGTERM` 信号，当达到超时时间进程还未完全停止的话，K8S 就会发送 `SIGKILL` 信号将其强制杀死。
+
+业务在 Kubernetes 环境中实际运行时，有时候可能会发现在滚动更新时，我们业务的优雅终止逻辑并没有被执行，现象是在等了较长时间后，业务进程直接被 `SIGKILL` 强制杀死了。
+
+### 什么原因?
+
+通常都是因为容器启动入口使用了 shell，比如使用了类似 `/bin/sh -c my-app` 这样的启动入口。 或者使用 `/entrypoint.sh` 这样的脚本文件作为入口，在脚本中再启动业务进程:
+
+![](https://image-host-1251893006.cos.ap-chengdu.myqcloud.com/2023%2F09%2F25%2F20230925110850.png)
+
+这就可能就会导致容器内的业务进程收不到 `SIGTERM` 信号，原因是:
+
+1. 容器主进程是 shell，业务进程是在 shell 中启动的，成为了 shell 进程的子进程。
+
+    ![](https://image-host-1251893006.cos.ap-chengdu.myqcloud.com/2023%2F09%2F25%2F20230925110858.png)
+2. shell 进程默认不会处理 `SIGTERM` 信号，自己不会退出，也不会将信号传递给子进程，导致业务进程不会触发停止逻辑。
+3. 当等到 K8S 优雅停止超时时间 (`terminationGracePeriodSeconds`，默认 30s)，发送 `SIGKILL` 强制杀死 shell 及其子进程。
+
+
+### 如何解决?
+
+1. 如果可以的话，尽量不使用 shell 启动业务进程。
+2. 如果一定要通过 shell 启动，比如在启动前需要用 shell 进程一些判断和处理，或者需要启动多个进程，那么就需要在 shell 中传递下 SIGTERM 信号了，解决方案请参考 [在 SHELL 中传递信号](#在-shell-中传递信号) 。
+
+## 在 SHELL 中传递信号
 
 在 Kubernetes 中，Pod 停止时 kubelet 会先给容器中的主进程发 `SIGTERM` 信号来通知进程进行 shutdown 以实现优雅停止，如果超时进程还未完全停止则会使用 `SIGKILL` 来强行终止。
 
@@ -6,7 +58,7 @@
 
 通常是因为我们的业务进程是在脚本中启动的，容器的启动入口使用了脚本，所以容器中的主进程并不是我们所希望的业务进程而是 shell 进程，导致业务进程收不到 `SIGTERM` 信号，更详细的原因在上一节我们已经介绍了，下面将介绍几种解决方案。
 
-## 使用 exec 启动
+### 使用 exec 启动
 
 在 shell 中启动二进制的命令前加一个 [exec](https://stackoverflow.com/questions/18351198/what-are-the-uses-of-the-exec-command-in-shell-scripts) 即可让该二进制启动的进程代替当前 shell 进程，即让新启动的进程成为主进程:
 
@@ -19,7 +71,7 @@ exec /bin/yourapp # 脚本中执行二进制
 
 然后业务进程就可以正常接收所有信号了，实现优雅退出也不在话下。
 
-## 多进程场景: 使用 trap 传递信号
+### 多进程场景: 使用 trap 传递信号
 
 通常我们一个容器只会有一个进程，也是 Kubernetes 的推荐做法。但有些时候我们不得不启动多个进程，比如从传统部署迁移到 Kubernetes 的过渡期间，使用了富容器，即单个容器中需要启动多个业务进程，这时也只能通过 shell 启动，但无法使用上面的 `exec` 方式来传递信号，因为 `exec` 只能让一个进程替代当前 shell 成为主进程。
 
@@ -44,7 +96,7 @@ trap handle_sigterm SIGTERM # 捕获 SIGTERM 信号并回调 handle_sigterm 函
 wait # 等待回调执行完，主进程再退出
 ```
 
-## 更好的方案: 使用 init 系统
+### 更好的方案: 使用 init 系统
 
 前面一种方案实际是用脚本实现了一个极简的 init 系统 (或 supervisor) 来管理所有子进程，只不过它的逻辑很简陋，仅仅简单的透传指定信号给子进程，其实社区有更完善的方案，[dumb-init](https://github.com/Yelp/dumb-init) 和 [tini](https://github.com/krallin/tini) 都可以作为 init 进程，作为主进程 (PID 1) 在容器中启动，然后它再运行 shell 来执行我们指定的脚本 (shell 作为子进程)，shell 中启动的业务进程也成为它的子进程，当它收到信号时会将其传递给所有的子进程，从而也能完美解决 SHELL 无法传递信号问题，并且还有回收僵尸进程的能力。
 

content/best-practices/graceful-shutdown/why-cannot-receive-sigterm.md

@@ -1,25 +0,0 @@
-# 为什么收不到 SIGTERM 信号？
-
-我们的业务代码通常会捕捉 `SIGTERM` 信号，然后执行停止逻辑以实现优雅终止。在 Kubernetes 环境中，业务发版时经常会对 workload 进行滚动更新，当旧版本 Pod 被删除时，K8S 会对 Pod 中各个容器中的主进程发送 `SIGTERM` 信号，当达到超时时间进程还未完全停止的话，K8S 就会发送 `SIGKILL` 信号将其强制杀死。
-
-业务在 Kubernetes 环境中实际运行时，有时候可能会发现在滚动更新时，我们业务的优雅终止逻辑并没有被执行，现象是在等了较长时间后，业务进程直接被 `SIGKILL` 强制杀死了。
-
-## 什么原因?
-
-通常都是因为容器启动入口使用了 shell，比如使用了类似 `/bin/sh -c my-app` 这样的启动入口。 或者使用 `/entrypoint.sh` 这样的脚本文件作为入口，在脚本中再启动业务进程:
-
-![](https://image-host-1251893006.cos.ap-chengdu.myqcloud.com/2023%2F09%2F25%2F20230925110850.png)
-
-这就可能就会导致容器内的业务进程收不到 `SIGTERM` 信号，原因是:
-
-1. 容器主进程是 shell，业务进程是在 shell 中启动的，成为了 shell 进程的子进程。
-
-    ![](https://image-host-1251893006.cos.ap-chengdu.myqcloud.com/2023%2F09%2F25%2F20230925110858.png)
-2. shell 进程默认不会处理 `SIGTERM` 信号，自己不会退出，也不会将信号传递给子进程，导致业务进程不会触发停止逻辑。
-3. 当等到 K8S 优雅停止超时时间 (`terminationGracePeriodSeconds`，默认 30s)，发送 `SIGKILL` 强制杀死 shell 及其子进程。
-
-
-## 如何解决?
-
-1. 如果可以的话，尽量不使用 shell 启动业务进程。
-2. 如果一定要通过 shell 启动，比如在启动前需要用 shell 进程一些判断和处理，或者需要启动多个进程，那么就需要在 shell 中传递下 SIGTERM 信号了，解决方案请参考 [在 SHELL 中传递信号](propagating-signals-in-shell.md) 。

content/best-practices/sidebars.ts

@@ -14,10 +14,8 @@ const sidebars: SidebarsConfig = {
       items: [
         'graceful-shutdown/intro',
         'graceful-shutdown/pod-termination-proccess',
-        'graceful-shutdown/code-example-of-handle-sigterm',
+        'graceful-shutdown/sigterm',
-        'graceful-shutdown/why-cannot-receive-sigterm',
+        'graceful-shutdown/prestop',
-        'graceful-shutdown/propagating-signals-in-shell',
-        'graceful-shutdown/use-prestop',
         'graceful-shutdown/update-strategy',
         'graceful-shutdown/long-connection',
         'graceful-shutdown/lb-to-pod-directly',