kubectl debug

Synopsis

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

'debug' 命令为集群对象提供常用调试任务的自动化,通过资源类型和名称进行标识。如果没有指定资源,默认使用 Pod。

'debug' 命令执行的操作因指定资源的不同而异。支持的操作包括:

  • 工作负载:创建现有 Pod 的副本,并更改某些属性,例如将镜像标签更改为新版本。
  • 工作负载:向已运行的 Pod 添加一个临时容器,例如添加调试工具而不重新启动 Pod。
  • 节点:创建一个新的 Pod,该 Pod 在节点的宿主命名空间中运行,并且可以访问节点的根文件系统。

注意:当目标 Pod 配置了非 root 用户时,调试配置文件授予的某些功能可能无法正常工作。

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

Options

--arguments-only

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

--attach

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

-c, --container string

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

--copy-to string

创建一个具有此名称的目标 Pod 的副本。

--custom string

指向包含用于自定义内置调试配置文件的部分容器规格的 JSON 或 YAML 文件的路径。

--env stringToString     默认值:[]

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

-f, --filename strings

标识要调试的资源

-h, --help

debug 命令的帮助

--image string

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

--image-pull-policy string

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

--keep-annotations

如果为 true,则保留原始 Pod 的注解。(此标志仅在与 '--copy-to' 一起使用时生效)

--keep-init-containers     默认值:true

运行 Pod 的 init 容器。默认为 true。(此标志仅在与 '--copy-to' 一起使用时生效)

--keep-labels

如果为 true,则保留原始 Pod 的标签。(此标志仅在与 '--copy-to' 一起使用时生效)

--keep-liveness

如果为 true,则保留原始 Pod 的存活探针。(此标志仅在与 '--copy-to' 一起使用时生效)

--keep-readiness

如果为 true,则保留原始 Pod 的就绪探针。(此标志仅在与 '--copy-to' 一起使用时生效)

--keep-startup

如果为 true,则保留原始 Pod 的启动探针。(此标志仅在与 '--copy-to' 一起使用时生效)

--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 中容器的标准输入打开。

--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 的客户端密钥文件路径

--cluster string

要使用的 kubeconfig 集群名称

--context string

要使用的 kubeconfig 上下文名称

--disable-compression

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

--insecure-skip-tls-verify

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

--kubeconfig string

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

--kuberc string

用于首选项的 kuberc 文件路径。可以通过导出 KUBECTL_KUBERC=false 功能标志或关闭 KUBERC=off 功能来禁用此功能。

--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 token

--user string

要使用的 kubeconfig 用户名

--username string

API 服务器基本身份验证的用户名

--version version[=true]

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

--warnings-as-errors

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

另请参阅

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

本页面是自动生成的。

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

最后修改于 2025 年 9 月 4 日下午 3:30 PST: Update kubectl reference for v1.34 (bdc4bba2a5)