调试正在运行的 Pod

本页说明如何在节点上调试正在运行（或崩溃）的 Pod。

开始之前

  • 您的 Pod 应已调度并正在运行。如果您的 Pod 尚未运行，请从 调试 Pod 开始。
  • 对于某些高级调试步骤，您需要知道 Pod 在哪个节点上运行，并具有 shell 访问权限才能在该节点上运行命令。您不需要该访问权限即可运行使用 kubectl 的标准调试步骤。

使用 kubectl describe pod 获取有关 Pod 的详细信息

对于此示例，我们将使用部署来创建两个 Pod，类似于前面的示例。

application/nginx-with-request.yaml 
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
spec:
  selector:
    matchLabels:
      app: nginx
  replicas: 2
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx
        resources:
          limits:
            memory: "128Mi"
            cpu: "500m"
        ports:
        - containerPort: 80

通过运行以下命令创建部署

kubectl apply -f https://k8s.io/examples/application/nginx-with-request.yaml

deployment.apps/nginx-deployment created

通过以下命令检查 Pod 状态

kubectl get pods

NAME                                READY   STATUS    RESTARTS   AGE
nginx-deployment-67d4bdd6f5-cx2nz   1/1     Running   0          13s
nginx-deployment-67d4bdd6f5-w6kd7   1/1     Running   0          13s

我们可以使用 kubectl describe pod 检索有关每个 Pod 的更多信息。例如

kubectl describe pod nginx-deployment-67d4bdd6f5-w6kd7

Name:         nginx-deployment-67d4bdd6f5-w6kd7
Namespace:    default
Priority:     0
Node:         kube-worker-1/192.168.0.113
Start Time:   Thu, 17 Feb 2022 16:51:01 -0500
Labels:       app=nginx
              pod-template-hash=67d4bdd6f5
Annotations:  <none>
Status:       Running
IP:           10.88.0.3
IPs:
  IP:           10.88.0.3
  IP:           2001:db8::1
Controlled By:  ReplicaSet/nginx-deployment-67d4bdd6f5
Containers:
  nginx:
    Container ID:   containerd://5403af59a2b46ee5a23fb0ae4b1e077f7ca5c5fb7af16e1ab21c00e0e616462a
    Image:          nginx
    Image ID:       docker.io/library/nginx@sha256:2834dc507516af02784808c5f48b7cbe38b8ed5d0f4837f16e78d00deb7e7767
    Port:           80/TCP
    Host Port:      0/TCP
    State:          Running
      Started:      Thu, 17 Feb 2022 16:51:05 -0500
    Ready:          True
    Restart Count:  0
    Limits:
      cpu:     500m
      memory:  128Mi
    Requests:
      cpu:        500m
      memory:     128Mi
    Environment:  <none>
    Mounts:
      /var/run/secrets/kubernetes.io/serviceaccount from kube-api-access-bgsgp (ro)
Conditions:
  Type              Status
  Initialized       True 
  Ready             True 
  ContainersReady   True 
  PodScheduled      True 
Volumes:
  kube-api-access-bgsgp:
    Type:                    Projected (a volume that contains injected data from multiple sources)
    TokenExpirationSeconds:  3607
    ConfigMapName:           kube-root-ca.crt
    ConfigMapOptional:       <nil>
    DownwardAPI:             true
QoS Class:                   Guaranteed
Node-Selectors:              <none>
Tolerations:                 node.kubernetes.io/not-ready:NoExecute op=Exists for 300s
                             node.kubernetes.io/unreachable:NoExecute op=Exists for 300s
Events:
  Type    Reason     Age   From               Message
  ----    ------     ----  ----               -------
  Normal  Scheduled  34s   default-scheduler  Successfully assigned default/nginx-deployment-67d4bdd6f5-w6kd7 to kube-worker-1
  Normal  Pulling    31s   kubelet            Pulling image "nginx"
  Normal  Pulled     30s   kubelet            Successfully pulled image "nginx" in 1.146417389s
  Normal  Created    30s   kubelet            Created container nginx
  Normal  Started    30s   kubelet            Started container nginx

在这里，您可以看到有关容器和 Pod 的配置信息（标签、资源需求等），以及有关容器和 Pod 的状态信息（状态、准备情况、重新启动次数、事件等）。

容器状态之一为等待、运行或已终止。根据状态，将提供其他信息——在这里，您可以看到对于处于运行状态的容器，系统会告诉您容器何时启动。

就绪性告诉你容器是否通过了其最近的就绪性探测。（在本例中，容器未配置就绪性探测；如果没有配置就绪性探测，则容器将被假定为就绪。）

重启次数告诉你容器已重启了多少次；此信息可用于检测配置了“始终”重启策略的容器中的崩溃循环。

目前与 Pod 关联的唯一条件是二进制就绪性条件，该条件指示 Pod 能够处理请求，并且应将其添加到所有匹配服务的负载均衡池中。

最后，你会看到与你的 Pod 相关的近期事件日志。“来源”指示正在记录事件的组件。“原因”和“消息”告诉你发生了什么。

示例：调试挂起的 Pod

你可以使用事件检测到的一个常见场景是，当你创建了一个无法适应任何节点的 Pod 时。例如，Pod 可能会请求比任何节点上的空闲资源更多的资源，或者它可能会指定与任何节点都不匹配的标签选择器。假设我们在一个四节点集群上创建了具有 5 个副本（而不是 2 个）并请求 600 毫核（而不是 500）的先前部署，其中每台（虚拟）机器有 1 个 CPU。在这种情况下，其中一个 Pod 将无法调度。（请注意，由于每个节点上运行的集群附加组件 Pod（例如 fluentd、skydns 等），如果我们请求 1000 毫核，那么任何 Pod 都无法调度。）

kubectl get pods

NAME                                READY     STATUS    RESTARTS   AGE
nginx-deployment-1006230814-6winp   1/1       Running   0          7m
nginx-deployment-1006230814-fmgu3   1/1       Running   0          7m
nginx-deployment-1370807587-6ekbw   1/1       Running   0          1m
nginx-deployment-1370807587-fg172   0/1       Pending   0          1m
nginx-deployment-1370807587-fz9sd   0/1       Pending   0          1m

要找出 nginx-deployment-1370807587-fz9sd Pod 未运行的原因，我们可以在挂起的 Pod 上使用 kubectl describe pod 并查看其事件

kubectl describe pod nginx-deployment-1370807587-fz9sd

  Name:		nginx-deployment-1370807587-fz9sd
  Namespace:	default
  Node:		/
  Labels:		app=nginx,pod-template-hash=1370807587
  Status:		Pending
  IP:
  Controllers:	ReplicaSet/nginx-deployment-1370807587
  Containers:
    nginx:
      Image:	nginx
      Port:	80/TCP
      QoS Tier:
        memory:	Guaranteed
        cpu:	Guaranteed
      Limits:
        cpu:	1
        memory:	128Mi
      Requests:
        cpu:	1
        memory:	128Mi
      Environment Variables:
  Volumes:
    default-token-4bcbi:
      Type:	Secret (a volume populated by a Secret)
      SecretName:	default-token-4bcbi
  Events:
    FirstSeen	LastSeen	Count	From			        SubobjectPath	Type		Reason			    Message
    ---------	--------	-----	----			        -------------	--------	------			    -------
    1m		    48s		    7	    {default-scheduler }			        Warning		FailedScheduling	pod (nginx-deployment-1370807587-fz9sd) failed to fit in any node
  fit failure on node (kubernetes-node-6ta5): Node didn't have enough resource: CPU, requested: 1000, used: 1420, capacity: 2000
  fit failure on node (kubernetes-node-wul5): Node didn't have enough resource: CPU, requested: 1000, used: 1100, capacity: 2000

在这里，你可以看到调度程序生成的事件，该事件表示 Pod 因 FailedScheduling（以及可能的其他原因）而无法调度。消息告诉我们，任何节点上都没有足够的资源供 Pod 使用。

要纠正这种情况，你可以使用 kubectl scale 来更新你的部署以指定四个或更少的副本。（或者你可以让一个 Pod 挂起，这是无害的。）

您在 kubectl describe pod 末尾看到的事件等事件会保存在 etcd 中，并提供有关集群中发生事件的高级信息。要列出所有事件，您可以使用

kubectl get events

但您必须记住，事件是有命名空间的。这意味着如果您对某个命名空间对象（例如 my-namespace 命名空间中的 Pod 发生了什么）的事件感兴趣，则需要明确地向命令提供一个命名空间

kubectl get events --namespace=my-namespace

要查看所有命名空间的事件，可以使用 --all-namespaces 参数。

除了 kubectl describe pod，获取 Pod 额外信息（超出 kubectl get pod 提供的信息）的另一种方法是将 -o yaml 输出格式标志传递给 kubectl get pod。这将以 YAML 格式为您提供比 kubectl describe pod 更多信息——基本上是系统关于 Pod 的所有信息。在这里，您将看到注释（这是具有键值元数据的元数据，没有标签限制，由 Kubernetes 系统组件在内部使用）、重新启动策略、端口和卷。

kubectl get pod nginx-deployment-1006230814-6winp -o yaml

apiVersion: v1
kind: Pod
metadata:
  creationTimestamp: "2022-02-17T21:51:01Z"
  generateName: nginx-deployment-67d4bdd6f5-
  labels:
    app: nginx
    pod-template-hash: 67d4bdd6f5
  name: nginx-deployment-67d4bdd6f5-w6kd7
  namespace: default
  ownerReferences:
  - apiVersion: apps/v1
    blockOwnerDeletion: true
    controller: true
    kind: ReplicaSet
    name: nginx-deployment-67d4bdd6f5
    uid: 7d41dfd4-84c0-4be4-88ab-cedbe626ad82
  resourceVersion: "1364"
  uid: a6501da1-0447-4262-98eb-c03d4002222e
spec:
  containers:
  - image: nginx
    imagePullPolicy: Always
    name: nginx
    ports:
    - containerPort: 80
      protocol: TCP
    resources:
      limits:
        cpu: 500m
        memory: 128Mi
      requests:
        cpu: 500m
        memory: 128Mi
    terminationMessagePath: /dev/termination-log
    terminationMessagePolicy: File
    volumeMounts:
    - mountPath: /var/run/secrets/kubernetes.io/serviceaccount
      name: kube-api-access-bgsgp
      readOnly: true
  dnsPolicy: ClusterFirst
  enableServiceLinks: true
  nodeName: kube-worker-1
  preemptionPolicy: PreemptLowerPriority
  priority: 0
  restartPolicy: Always
  schedulerName: default-scheduler
  securityContext: {}
  serviceAccount: default
  serviceAccountName: default
  terminationGracePeriodSeconds: 30
  tolerations:
  - effect: NoExecute
    key: node.kubernetes.io/not-ready
    operator: Exists
    tolerationSeconds: 300
  - effect: NoExecute
    key: node.kubernetes.io/unreachable
    operator: Exists
    tolerationSeconds: 300
  volumes:
  - name: kube-api-access-bgsgp
    projected:
      defaultMode: 420
      sources:
      - serviceAccountToken:
          expirationSeconds: 3607
          path: token
      - configMap:
          items:
          - key: ca.crt
            path: ca.crt
          name: kube-root-ca.crt
      - downwardAPI:
          items:
          - fieldRef:
              apiVersion: v1
              fieldPath: metadata.namespace
            path: namespace
status:
  conditions:
  - lastProbeTime: null
    lastTransitionTime: "2022-02-17T21:51:01Z"
    status: "True"
    type: Initialized
  - lastProbeTime: null
    lastTransitionTime: "2022-02-17T21:51:06Z"
    status: "True"
    type: Ready
  - lastProbeTime: null
    lastTransitionTime: "2022-02-17T21:51:06Z"
    status: "True"
    type: ContainersReady
  - lastProbeTime: null
    lastTransitionTime: "2022-02-17T21:51:01Z"
    status: "True"
    type: PodScheduled
  containerStatuses:
  - containerID: containerd://5403af59a2b46ee5a23fb0ae4b1e077f7ca5c5fb7af16e1ab21c00e0e616462a
    image: docker.io/library/nginx:latest
    imageID: docker.io/library/nginx@sha256:2834dc507516af02784808c5f48b7cbe38b8ed5d0f4837f16e78d00deb7e7767
    lastState: {}
    name: nginx
    ready: true
    restartCount: 0
    started: true
    state:
      running:
        startedAt: "2022-02-17T21:51:05Z"
  hostIP: 192.168.0.113
  phase: Running
  podIP: 10.88.0.3
  podIPs:
  - ip: 10.88.0.3
  - ip: 2001:db8::1
  qosClass: Guaranteed
  startTime: "2022-02-17T21:51:01Z"

检查 Pod 日志

首先，查看受影响容器的日志

kubectl logs ${POD_NAME} ${CONTAINER_NAME}

如果您的容器以前已崩溃，则可以使用以下命令访问以前容器的崩溃日志

kubectl logs --previous ${POD_NAME} ${CONTAINER_NAME}

使用容器 exec 调试

如果 容器镜像 包括调试实用程序（例如使用 Linux 和 Windows 操作系统基础镜像构建的镜像），您可以使用 kubectl exec 在特定容器内运行命令

kubectl exec ${POD_NAME} -c ${CONTAINER_NAME} -- ${CMD} ${ARG1} ${ARG2} ... ${ARGN}

例如，要查看正在运行的 Cassandra Pod 的日志，您可以运行

kubectl exec cassandra -- cat /var/log/cassandra/system.log

您可以使用 -i 和 -t 参数将连接到您的终端的 shell 运行到 kubectl exec，例如

kubectl exec -it cassandra -- sh

有关更多详细信息，请参阅 获取正在运行容器的 Shell。

使用临时调试容器进行调试

功能状态： Kubernetes v1.25 [稳定]

临时容器 在 kubectl exec 不够用时可用于交互式故障排除，因为容器已崩溃或容器镜像不包含调试实用程序，例如 distroless 镜像。

使用临时容器进行调试的示例

您可以使用 kubectl debug 命令将临时容器添加到正在运行的 Pod 中。首先，为示例创建一个 Pod

kubectl run ephemeral-demo --image=registry.k8s.io/pause:3.1 --restart=Never

本节中的示例使用 pause 容器映像，因为它不包含调试实用程序，但此方法适用于所有容器映像。

如果您尝试使用 kubectl exec 创建 shell，您会看到一个错误，因为此容器映像中没有 shell。

kubectl exec -it ephemeral-demo -- sh

OCI runtime exec failed: exec failed: container_linux.go:346: starting container process caused "exec: \"sh\": executable file not found in $PATH": unknown

您可以改用 kubectl debug 添加调试容器。如果您指定 -i/--interactive 参数，kubectl 将自动附加到临时容器的控制台。

kubectl debug -it ephemeral-demo --image=busybox:1.28 --target=ephemeral-demo

Defaulting debug container name to debugger-8xzrl.
If you don't see a command prompt, try pressing enter.
/ #

此命令添加一个新的 busybox 容器并附加到它。--target 参数针对另一个容器的进程命名空间。这里有必要，因为 kubectl run 不会启用它创建的 Pod 中的 进程命名空间共享。

您可以使用 kubectl describe 查看新创建的临时容器的状态

kubectl describe pod ephemeral-demo

...
Ephemeral Containers:
  debugger-8xzrl:
    Container ID:   docker://b888f9adfd15bd5739fefaa39e1df4dd3c617b9902082b1cfdc29c4028ffb2eb
    Image:          busybox
    Image ID:       docker-pullable://busybox@sha256:1828edd60c5efd34b2bf5dd3282ec0cc04d47b2ff9caa0b6d4f07a21d1c08084
    Port:           <none>
    Host Port:      <none>
    State:          Running
      Started:      Wed, 12 Feb 2020 14:25:42 +0100
    Ready:          False
    Restart Count:  0
    Environment:    <none>
    Mounts:         <none>
...

完成后，使用 kubectl delete 删除 Pod

kubectl delete pod ephemeral-demo

使用 Pod 的副本进行调试

有时，Pod 配置选项会让在某些情况下进行故障排除变得困难。例如，如果您的容器映像不包含 shell 或如果您的应用程序在启动时崩溃，您无法运行 kubectl exec 来对容器进行故障排除。在这些情况下，您可以使用 kubectl debug 创建 Pod 的副本，并更改配置值以帮助进行调试。

在添加新容器的同时复制 Pod

当您的应用程序正在运行但行为与您的预期不符，并且您希望向 Pod 添加其他故障排除实用程序时，添加新容器可能很有用。

例如，您的应用程序的容器映像可能基于 busybox 构建，但您需要 busybox 中不包含的调试实用程序。您可以使用 kubectl run 模拟此场景

kubectl run myapp --image=busybox:1.28 --restart=Never -- sleep 1d

运行此命令以创建名为 myapp-debug 的 myapp 副本，该副本添加了一个新的 Ubuntu 容器用于调试

kubectl debug myapp -it --image=ubuntu --share-processes --copy-to=myapp-debug

Defaulting debug container name to debugger-w7xmf.
If you don't see a command prompt, try pressing enter.
root@myapp-debug:/#

完成后，别忘了清理调试 Pod

kubectl delete pod myapp myapp-debug

在更改其命令时复制 Pod

有时更改容器的命令很有用，例如添加调试标志或因为应用程序崩溃。

要模拟崩溃的应用程序，请使用 kubectl run 创建一个立即退出的容器

kubectl run --image=busybox:1.28 myapp -- false

您可以使用 kubectl describe pod myapp 看到此容器正在崩溃

Containers:
  myapp:
    Image:         busybox
    ...
    Args:
      false
    State:          Waiting
      Reason:       CrashLoopBackOff
    Last State:     Terminated
      Reason:       Error
      Exit Code:    1

您可以使用 kubectl debug 创建此 Pod 的副本，并将命令更改为交互式 shell

kubectl debug myapp -it --copy-to=myapp-debug --container=myapp -- sh

If you don't see a command prompt, try pressing enter.
/ #

现在，您拥有一个交互式 shell，可以使用它来执行诸如检查文件系统路径或手动运行容器命令之类的任务。

完成后，别忘了清理调试 Pod

kubectl delete pod myapp myapp-debug

在更改容器映像时复制 Pod

在某些情况下，您可能希望将行为不端的 Pod 从其正常的生产容器映像更改为包含调试版本或其他实用程序的映像。

作为一个示例，使用 kubectl run 创建一个 Pod

kubectl run myapp --image=busybox:1.28 --restart=Never -- sleep 1d

现在使用 kubectl debug 进行复制，并将其容器映像更改为 ubuntu

kubectl debug myapp --copy-to=myapp-debug --set-image=*=ubuntu

--set-image 的语法使用与 kubectl set image 相同的 container_name=image 语法。*=ubuntu 表示将所有容器的映像更改为 ubuntu。

完成后，别忘了清理调试 Pod

kubectl delete pod myapp myapp-debug

通过节点上的 shell 进行调试

如果这些方法都不起作用，您可以找到运行 Pod 的节点并在节点上创建一个 Pod。要使用 kubectl debug 在节点上创建交互式 shell，请运行

kubectl debug node/mynode -it --image=ubuntu

Creating debugging pod node-debugger-mynode-pdx84 with container debugger on node mynode.
If you don't see a command prompt, try pressing enter.
root@ek8s:/#

在节点上创建调试会话时，请记住

  • kubectl debug 根据节点名称自动生成新 Pod 的名称。
  • 节点的根文件系统将装载在 /host。
  • 容器在主机 IPC、网络和 PID 命名空间中运行，尽管 Pod 没有特权，因此读取某些进程信息可能会失败，并且 chroot /host 可能会失败。
  • 如果您需要一个特权 Pod，请手动创建它或使用 --profile=sysadmin 标志。

完成后，别忘了清理调试 Pod

kubectl delete pod node-debugger-mynode-pdx84

调试配置文件

当使用 kubectl debug 通过调试 Pod、通过临时容器或复制的 Pod 调试节点时，您可以使用 --profile 标志向它们应用调试配置文件。通过应用配置文件，可以设置特定属性，例如 securityContext，以便适应各种场景。

可用的配置文件如下

配置文件说明
legacy一组与 1.22 行为向后兼容的属性
general一组适用于每个调试过程的合理通用属性
baseline一组与 PodSecurityStandard 基线策略 兼容的属性
restricted一组与 PodSecurityStandard 限制策略 兼容的属性
netadmin一组包含网络管理员权限的属性
sysadmin一组包含系统管理员 (root) 权限的属性

假设您创建一个 Pod 并对其进行调试。首先，创建一个名为 myapp 的 Pod 作为示例

kubectl run myapp --image=busybox:1.28 --restart=Never -- sleep 1d

然后，使用临时容器调试 Pod。如果临时容器需要具有特权，则可以使用 sysadmin 配置文件

kubectl debug -it myapp --image=busybox:1.28 --target=myapp --profile=sysadmin

Targeting container "myapp". If you don't see processes from this container it may be because the container runtime doesn't support this feature.
Defaulting debug container name to debugger-6kg4x.
If you don't see a command prompt, try pressing enter.
/ #

通过在容器内运行以下命令来检查临时容器进程的功能

/ # grep Cap /proc/$$/status

...
CapPrm:	000001ffffffffff
CapEff:	000001ffffffffff
...

这意味着通过应用sysadmin配置文件，容器进程被授予完全功能，成为特权容器。请参阅有关功能的更多详细信息。

您还可以检查临时容器是否已创建为特权容器

kubectl get pod myapp -o jsonpath='{.spec.ephemeralContainers[0].securityContext}'

{"privileged":true}

完成后清理 Pod

kubectl delete pod myapp
上次修改时间为 2024 年 6 月 27 日上午 8:48 PST：添加有关调试配置文件的说明 (0c8a63f4a2)