kubectl debug

概要

使用交互式调试容器调试集群资源。

“debug” 为通过资源和名称标识的集群对象的常见调试任务提供自动化。 如果未指定资源,则默认使用 Pod。

“debug” 采取的操作因指定的资源而异。 支持的操作包括

  • 工作负载:创建现有 Pod 的副本,并更改某些属性,例如将镜像标签更改为新版本。
  • 工作负载:将临时容器添加到已运行的 Pod,例如添加调试实用程序而不重新启动 Pod。
  • 节点:创建一个在新 Pod 中运行的新 Pod,该 Pod 在节点的主机命名空间中运行,并且可以访问节点的文件系统。
kubectl debug (POD | TYPE[[.VERSION].GROUP]/NAME) [ -- COMMAND [args...] ]

示例

  # Create an interactive debugging session in pod mypod and immediately attach to it.
  kubectl debug mypod -it --image=busybox
  
  # Create an interactive debugging session for the pod in the file pod.yaml and immediately attach to it.
  # (requires the EphemeralContainers feature to be enabled in the cluster)
  kubectl debug -f pod.yaml -it --image=busybox
  
  # Create a debug container named debugger using a custom automated debugging image.
  kubectl debug --image=myproj/debug-tools -c debugger mypod
  
  # Create a copy of mypod adding a debug container and attach to it
  kubectl debug mypod -it --image=busybox --copy-to=my-debugger
  
  # Create a copy of mypod changing the command of mycontainer
  kubectl debug mypod -it --copy-to=my-debugger --container=mycontainer -- sh
  
  # Create a copy of mypod changing all container images to busybox
  kubectl debug mypod --copy-to=my-debugger --set-image=*=busybox
  
  # Create a copy of mypod adding a debug container and changing container images
  kubectl debug mypod -it --copy-to=my-debugger --image=debian --set-image=app=app:debug,sidecar=sidecar:debug
  
  # Create an interactive debugging session on a node and immediately attach to it.
  # The container will run in the host namespaces and the host's filesystem will be mounted at /host
  kubectl debug node/mynode -it --image=busybox

选项

--arguments-only

如果指定,则 -- 之后的所有内容都将作为 Args 而不是 Command 传递给新容器。

--attach

如果为 true,则等待容器开始运行,然后像调用“kubectl attach ...”一样附加。 默认为 false,除非设置了“-i/--stdin”,在这种情况下默认为 true。

-c, --container string

用于调试容器的容器名称。

--copy-to string

使用此名称创建目标 Pod 的副本。

--env stringToString     默认值:[]

要在容器中设置的环境变量。

-f, --filename strings

标识要调试的资源

-h, --help

debug 的帮助

--image string

用于调试容器的容器镜像。

--image-pull-policy string

容器的镜像拉取策略。 如果留空,则客户端不会指定此值,而是由服务器默认设置。

--profile string     默认值:"legacy"

选项为“legacy”、“general”、“baseline”、“netadmin”、“restricted”或“sysadmin”。

-q, --quiet

如果为 true,则抑制信息性消息。

--replace

与“--copy-to”一起使用时,删除原始 Pod。

--same-node

与“--copy-to”一起使用时,在同一节点上调度目标 Pod 的副本。

--set-image stringToString     默认值:[]

与“--copy-to”一起使用时,用于更改容器镜像的 name=image 对列表,类似于“kubectl set image”的工作方式。

--share-processes     默认值:true

与“--copy-to”一起使用时,在副本中启用进程命名空间共享。

-i, --stdin

保持 Pod 中容器上的 stdin 打开,即使没有任何内容附加。

--target string

使用临时容器时,在此容器名称中定位进程。

-t, --tty

为调试容器分配一个 TTY。

--as string

要为操作模拟的用户名。 用户可以是命名空间中的普通用户或服务帐户。

--as-group strings

要为操作模拟的组,可以重复此标志以指定多个组。

--as-uid string

要为操作模拟的 UID。

--cache-dir string     默认值:"$HOME/.kube/cache"

默认缓存目录

--certificate-authority string

证书颁发机构的证书文件路径

--client-certificate string

TLS 客户端证书文件的路径

--client-key string

TLS 客户端密钥文件的路径

--cloud-provider-gce-l7lb-src-cidrs cidrs     默认值:130.211.0.0/22,35.191.0.0/16

在 GCE 防火墙中为 L7 LB 流量代理和健康检查打开的 CIDR

--cloud-provider-gce-lb-src-cidrs cidrs     默认值:130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16

在 GCE 防火墙中为 L4 LB 流量代理和健康检查打开的 CIDR

--cluster string

要使用的 kubeconfig 集群的名称

--context string

要使用的 kubeconfig 上下文的名称

--default-not-ready-toleration-seconds int     默认值:300

指示默认添加到每个尚不具有此类容忍的 Pod 的 notReady:NoExecute 容忍的 tolerationSeconds。

--default-unreachable-toleration-seconds int     默认值:300

指示默认添加到每个尚不具有此类容忍的 Pod 的 unreachable:NoExecute 容忍的 tolerationSeconds。

--disable-compression

如果为 true,则对服务器的所有请求都选择退出响应压缩

--insecure-skip-tls-verify

如果为 true,则不会检查服务器证书的有效性。 这将使您的 HTTPS 连接不安全

--kubeconfig string

用于 CLI 请求的 kubeconfig 文件的路径。

--match-server-version

要求服务器版本与客户端版本匹配

-n, --namespace string

如果存在,则为此 CLI 请求设置命名空间范围

--password string

用于对 API 服务器进行基本身份验证的密码

--profile-output string     默认值:"profile.pprof"

要将配置文件写入的文件的名称

--request-timeout string     默认值:"0"

放弃单个服务器请求之前等待的时间长度。 非零值应包含相应的时间单位(例如 1s、2m、3h)。 值为零表示不超时请求。

-s, --server string

Kubernetes API 服务器的地址和端口

--storage-driver-buffer-duration duration     默认值:1m0s

存储驱动程序中的写入将被缓冲这段时间,并作为单个事务提交到非内存后端

--storage-driver-db string     默认值:"cadvisor"

数据库名称

--storage-driver-host string     默认值:"localhost:8086"

数据库主机:端口

--storage-driver-password string     默认值:"root"

数据库密码

--storage-driver-secure

使用与数据库的安全连接

--storage-driver-table string     默认值:"stats"

表名

--storage-driver-user string     默认值:"root"

数据库用户名

--tls-server-name string

用于服务器证书验证的服务器名称。 如果未提供,则使用用于联系服务器的主机名

--token string

用于对 API 服务器进行身份验证的 Bearer 令牌

--user string

要使用的 kubeconfig 用户的名称

--username string

用于对 API 服务器进行基本身份验证的用户名

--version version[=true]

--version、--version=raw 打印版本信息并退出;--version=vX.Y.Z... 设置报告的版本

--warnings-as-errors

将从服务器收到的警告视为错误,并以非零退出代码退出

另见

  • kubectl - kubectl 控制 Kubernetes 集群管理器

本页面自动生成。

如果您打算报告此页面的问题,请在问题描述中提及该页面是自动生成的。 修复可能需要在 Kubernetes 项目的其他地方进行。

上次修改时间:2024 年 4 月 18 日下午 6:36 PST:更新 v1.30 的 kubectl 参考 (a6ccd20be9)