容器生命周期钩子

本页面描述了 kubelet 管理的容器如何使用容器生命周期钩子框架来运行由其管理生命周期事件触发的代码。

概述

与许多具有组件生命周期钩子的编程语言框架(例如 Angular)类似,Kubernetes 为容器提供了生命周期钩子。这些钩子使容器能够感知其管理生命周期中的事件,并在执行相应的生命周期钩子时运行处理程序中实现的代码。

容器钩子

暴露给容器的钩子有两种

PostStart

此钩子在容器创建后立即执行。但是,不能保证该钩子会在容器 ENTRYPOINT 之前执行。没有参数传递给处理程序。

PreStop

此钩子在容器因 API 请求或管理事件(例如活性/启动探针失败、抢占、资源争用等)而终止之前立即调用。如果容器已经处于终止或完成状态,则对 PreStop 钩子的调用将失败,并且该钩子必须在发送用于停止容器的 TERM 信号之前完成。Pod 的终止宽限期倒计时在 PreStop 钩子执行之前开始,因此无论处理程序的结果如何,容器最终都会在 Pod 的终止宽限期内终止。没有参数传递给处理程序。

有关终止行为的更详细描述,请参阅Pod 终止

StopSignal

StopSignal 生命周期可用于定义一个停止信号,该信号将在容器停止时发送给容器。如果设置此项,它将覆盖容器镜像中定义的任何 STOPSIGNAL 指令。

有关使用自定义停止信号的终止行为的更详细描述,请参阅停止信号

钩子处理程序实现

容器可以通过实现并注册该钩子的处理程序来访问钩子。可以为容器实现三种类型的钩子处理程序

  • Exec - 在容器的 cgroups 和命名空间内执行特定命令,例如 pre-stop.sh。命令消耗的资源计入容器。
  • HTTP - 对容器上的特定端点执行 HTTP 请求。
  • Sleep - 暂停容器指定时长。

钩子处理程序执行

当调用容器生命周期管理钩子时,Kubernetes 管理系统会根据钩子操作执行处理程序,httpGettcpSocket (已弃用) 和 sleep 由 kubelet 进程执行,而 exec 在容器中执行。

PostStart 钩子处理程序调用在容器创建时启动,这意味着容器 ENTRYPOINT 和 PostStart 钩子同时触发。但是,如果 PostStart 钩子执行时间过长或挂起,它可能会阻止容器转换为 running 状态。

PreStop 钩子与停止容器的信号并非异步执行;该钩子必须在 TERM 信号发送之前完成其执行。如果 PreStop 钩子在执行期间挂起,则 Pod 的阶段将为 Terminating 并保持在那里,直到 Pod 在其 terminationGracePeriodSeconds 到期后被终止。此宽限期适用于 PreStop 钩子执行和容器正常停止的总时间。例如,如果 terminationGracePeriodSeconds 为 60 秒,并且钩子需要 55 秒才能完成,并且容器在收到信号后需要 10 秒才能正常停止,那么容器将在正常停止之前被终止,因为 terminationGracePeriodSeconds 小于这两个事件发生所需的总时间(55 + 10)。

如果 PostStartPreStop 钩子失败,它将终止容器。

用户应尽可能使他们的钩子处理程序轻量级。然而,在某些情况下,长时间运行的命令是有意义的,例如在停止容器之前保存状态。

钩子传递保证

钩子传递旨在实现**至少一次**,这意味着对于任何给定事件,例如 PostStartPreStop,钩子可能会被调用多次。正确处理此问题取决于钩子实现。

通常,只会进行一次传递。例如,如果 HTTP 钩子接收器出现故障且无法处理流量,则不会尝试重新发送。但在某些罕见情况下,可能会发生双重传递。例如,如果 kubelet 在发送钩子过程中重新启动,则钩子可能会在 kubelet 重新启动后重新发送。

调试钩子处理程序

钩子处理程序的日志不会在 Pod 事件中公开。如果处理程序因某种原因失败,它会广播一个事件。对于 PostStart,这是 FailedPostStartHook 事件,对于 PreStop,这是 FailedPreStopHook 事件。要自己生成一个失败的 FailedPostStartHook 事件,请修改 lifecycle-events.yaml 文件,将 postStart 命令更改为“badcommand”并应用它。以下是运行 kubectl describe pod lifecycle-demo 后看到的事件的一些示例输出

Events:
  Type     Reason               Age              From               Message
  ----     ------               ----             ----               -------
  Normal   Scheduled            7s               default-scheduler  Successfully assigned default/lifecycle-demo to ip-XXX-XXX-XX-XX.us-east-2...
  Normal   Pulled               6s               kubelet            Successfully pulled image "nginx" in 229.604315ms
  Normal   Pulling              4s (x2 over 6s)  kubelet            Pulling image "nginx"
  Normal   Created              4s (x2 over 5s)  kubelet            Created container lifecycle-demo-container
  Normal   Started              4s (x2 over 5s)  kubelet            Started container lifecycle-demo-container
  Warning  FailedPostStartHook  4s (x2 over 5s)  kubelet            Exec lifecycle hook ([badcommand]) for Container "lifecycle-demo-container" in Pod "lifecycle-demo_default(30229739-9651-4e5a-9a32-a8f1688862db)" failed - error: command 'badcommand' exited with 126: , message: "OCI runtime exec failed: exec failed: container_linux.go:380: starting container process caused: exec: \"badcommand\": executable file not found in $PATH: unknown\r\n"
  Normal   Killing              4s (x2 over 5s)  kubelet            FailedPostStartHook
  Normal   Pulled               4s               kubelet            Successfully pulled image "nginx" in 215.66395ms
  Warning  BackOff              2s (x2 over 3s)  kubelet            Back-off restarting failed container

下一步

上次修改时间:2024 年 10 月 12 日太平洋标准时间上午 10:56:[KEP-3960] - 更新 GA 文档 (6a1b6c1649)