版本：v1.8

PodProbeMarker

FEATURE STATE: Kruise v1.3.0

Kubernetes提供了三种默认的Pod生命周期管理：

Readiness Probe 用来判断业务容器是否已经准备好响应用户请求，如果检查失败，会将该Pod从Service Endpoints中剔除。
Liveness Probe 用来判断容器的健康状态，如果检查失败，kubelet将会重启该容器。
Startup Probe 用来判断容器是否启动完成，如果定义了该Probe，那么Readiness Probe与Liveness Probe将会在它成功之后再执行。

所以Kubernetes中提供的Probe能力都已经限定了特定的语义以及相关的行为。**除此之外，其实还是存在自定义Probe语义以及相关行为的需求 **，例如：

GameServer定义 Idle Probe 用来判断该Pod当前是否存在游戏对局，如果没有，从成本优化的角度，可以将该Pod缩容掉。
K8S Operator定义 main-secondary Probe 来判断当前Pod的角色（main or secondary），升级的时候，可以优先升级 secondary，进而达到升级过程只有一次选主的行为，降低升级过程中服务抖动时间。

OpenKruise提供了自定义Probe的能力，并将结果返回到Pod Status中，用户可以根据该结果决定后续的行为。

Feature-gate

PodProbeMarker能力默认是开启的, 你可以通过 feature-gate PodProbeMarkerGate 关闭，如下：

$ helm install kruise https://... --set featureGates="PodProbeMarkerGate=false"

Usage

apiVersion: apps.kruise.io/v1alpha1
kind: PodProbeMarker
metadata:
  name: game-server-probe
  namespace: ns
spec:
  selector:
    matchLabels:
      app: game-server
  probes:
  - name: Idle
    containerName: game-server
    probe:
      exec:
        command:
        - /home/game/idle.sh
      initialDelaySeconds: 10
      timeoutSeconds: 3
      periodSeconds: 10
      successThreshold: 1
      failureThreshold: 3
    markerPolicy:
    - state: Succeeded
      labels:
        gameserver-idle: 'true'
      annotations:
        controller.kubernetes.io/pod-deletion-cost: '-10'
    - state: Failed
      labels:
        gameserver-idle: 'false'
      annotations:
        controller.kubernetes.io/pod-deletion-cost: '10'
    podConditionType: game.io/idle

spec.selector: 根据Label选择匹配的Pods，MatchLabels和MatchExpressions都支持。详情请参考：https://kubernetes.io/docs/concepts/overview/working-with-objects/labels 。定义后，该selector不允许修改。
spec.probes
- name: probe名字，需要在Pod内是唯一的，哪怕不同的容器之间也需要唯一
- containerName: 执行probe的容器
- probe: probe相关的API定义，与原生K8S probe一致（当前只支持 Exec）。详情请参考：https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes
- markerPolicy: 根据Probe执行结果（Succeeded或Failed），在Pod上面打特定的Labels和Annotations。
  - state: probe结果，Succeeded 或 Failed
  - labels: 如果结果满足，打 labels 到Pod上
  - annotations: 如果结果满足，打 annotations 到Pod上
- podConditionType: 将Probe执行结果（Succeeded或Failed）保存到pod condition上。如果该字段为空，probe执行结果将不会同步到pod condition。

注意： 如果只定义了一种Marker Policy策略，例如：只定义了 State=Succeeded，Patch Labels[healthy]='true' 。当Probe执行成功时，将会Patch Label[healthy]='true' 到Pod上。当Probe执行失败时，Label[healthy]将会被删除。

支持 TcpSocket Probe

FEATURE STATE: Kruise v1.6.0

根据如下配置，kruise-daemon 会尝试与容器 Port 建立一个socket连接，如果建立成功，则 Probe 将会返回 Succeeded，否则 Failed。

apiVersion: apps.kruise.io/v1alpha1
kind: PodProbeMarker
metadata:
  name: game-server-probe
  namespace: ns
spec:
  selector:
    matchLabels:
      app: game-server
  probes:
    - name: Idle
      containerName: game-server
      probe:
        tcpSocket:
          port: 8080
        initialDelaySeconds: 15
        periodSeconds: 10

支持 serverless 场景

FEATURE STATE: Kruise v1.8.0

背景

在 Kruise v1.8.0 之前，PodProbeMarker 的探测能力依赖于 Kruise Daemon 组件实现。针对使用 serverless 资源部署 OKG 等典型场景，Kruise v1.8.0 引入了针对 PodProbeMarker Serverless 场景的扩展协议。

注意：不同 serverless 容器服务厂商对 PodProbeMarker 的支持存在差异，需咨询对应厂商该协议的支持情况。

Kriuse 欢迎汇报支持该协议的厂商列表：

阿里云容器计算服务 ACS

协议介绍

支持 serverless PodProbeMarker 能力默认是关闭的, 你可以通过 feature-gate EnablePodProbeMarkerOnServerless 打开，如下：

helm install kruise https://... --set featureGates="PodProbeMarkerGate=true,EnablePodProbeMarkerOnServerless=true"

该特性在 PodProbeMarker 的定义了对 serverless 场景的交互协议：

Kruise-manager 通过 annotation kruise.io/podprobe 在 serverless Pod 上添加需要进行的探测。
serverless PodProbeMarker 具体实现需要从 annotation kruise.io/podprobe 中读取探测信息、执行探测，并将结果写到 Pod 的 .status.conditions[x] 中。
Kruise-manager 通过识别 serverless Pod 的 .status.conditions[x] 中识别到 Probe 执行结果，并执行 markerPolicy 中定义的标记操作。

示例参考如下：

apiVersion: v1
kind: Pod
metadata:
  annotations:
    # 记录需要对该 Pod 进行的探测，由各种实现负责读取信息并探测
    kruise.io/podprobe: |
      [
      	{
      		"containerName": "minecraft",
      		"name": "healthy",
      		"podConditionType": "game.kruise.io/healthy",
      		"probe": {
      			"exec": {
      				"command": [
      					"bash",
      					"/data/probe.sh"
      				]
      			}
      		}
      	}
      ]
...
status:
  conditions:
  # 探测的结果记录在 .status.conditions 中，type 为 podConditionType
  - type: game.kruise.io/healthy
    # Probe State 'Succeeded' indicates 'True', and 'Failed' indicates 'False'
    status: "True"
    lastProbeTime: "2025-03-25T07:13:04Z"
    lastTransitionTime: "2025-03-25T07:13:04Z"
    # If the probe fails to execute, the message is stderr
    message: ""

How to view Probe results?

Pod Status Conditions

如果用户定义了podConditionType，将Probe执行结果（Succeeded或Failed）保存到pod condition上，其中* condition.type=podConditionType*，具体如下：

apiVersion: v1
kind: Pod
metadata:
  labels:
    app: game-server
  name: game-server-58cb9f5688-7sbd8
  namespace: ns
...
status:
  conditions:
    # podConditionType
  - type: game.io/idle
    # Probe State 'Succeeded' indicates 'True', and 'Failed' indicates 'False'
    status: "True"
    lastProbeTime: "2022-09-09T07:13:04Z"
    lastTransitionTime: "2022-09-09T07:13:04Z"
    # If the probe fails to execute, the message is stderr
    message: ""

该种方式可以与Kubernetes Readiness Gate 结合使用，达到灵活控制Pod是否Ready的效果。

Pod Metadata

如果用户定义了 MarkerPolicy，OpenKruise将会Patch特定的Metadata到Pod上，如下：

apiVersion: v1
kind: Pod
metadata:
  labels:
    app: game-server
    gameserver-idle: 'true'
  annotations:
    controller.kubernetes.io/pod-deletion-cost: '-10'
  name: game-server-58cb9f5688-7sbd8
  namespace: ns

OpenKruise CloneSet 与 Advanced StatefulSet 都支持根据Pod Label控制升级优先级的能力。与此同时，社区原生Deployment与Kruise CloneSet也支持基于 Deletion Cost 的缩容优先级以及升级顺序。所以Custom Probe MarkerPolicy可以与上面能力相结合，达到缩容或升级优先级的效果。

Pod Event

通过pod event可以查看历史的probe执行结果，如下：

$ kubectl describe pods -n ns game-server-58cb9f5688-7sbd8
Events:
  Type    Reason                Age                From                         Message
  ----    ------                ----               ----                         -------
  Normal  KruiseProbeFailed     37s (x2 over 47s)  kruise-daemon-podprobe
  Normal  KruiseProbeSucceeded  36s (x2 over 37s)  kruise-daemon-podprobe

Feature-gate​

Usage​

支持 TcpSocket Probe​

支持 serverless 场景​

背景​

协议介绍​

How to view Probe results?​

Pod Status Conditions​

Pod Metadata​

Pod Event​