kubectl debug

简介

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

“debug” 针对按资源和名称标识的集群对象为常用的调试任务提供自动化操作。如果不指定资源，则默认使用 Pod。

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

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

示例

  1. # 在名为 mypod 的 Pod 中创建一个交互式调试会话并立即挂接到此会话
  2. kubectl debug mypod -it --image=busybox
  4. # 为文件 pod.yaml 中的 Pod 创建一个交互式调试会话并立即挂接到此会话
  5. # （需要在集群中启用 EphemeralContainers 特性）
  6. kubectl debug -f pod.yaml -it --image=busybox
  8. # 使用特定的自动调试镜像创建一个名为 debugger 的调试容器
  9. kubectl debug --image=myproj/debug-tools -c debugger mypod
  11. # 创建 mypod 的副本，添加调试容器并挂接到此容器
  12. kubectl debug mypod -it --image=busybox --copy-to=my-debugger
  14. # 创建 mypod 的副本，更改 mycontainer 的命令
  15. kubectl debug mypod -it --copy-to=my-debugger --container=mycontainer -- sh
  17. # 创建 mypod 的副本，将所有容器镜像更改为 busybox
  18. kubectl debug mypod --copy-to=my-debugger --set-image=*=busybox
  20. # 创建 mypod 的副本，添加调试容器并更改容器镜像
  21. kubectl debug mypod -it --copy-to=my-debugger --image=debian --set-image=app=app:debug,sidecar=sidecar:debug
  23. # 在节点上创建一个交互式调试会话并立即挂接到此会话
  24. # 容器将在主机命名空间中运行，主机的文件系统将被挂载到 /host
  25. 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 的副本，并将副本命名为指定名称。

—custom string

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

—env stringToString     默认值：[]

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

-f, —filename strings

标识要调试的资源。

-h, —help

debug 操作的帮助命令。

—image string

调试容器要使用的容器镜像。

—image-pull-policy string

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

—keep-annotations

如果为真，则保留原始 Pod 的注解。 （此标志仅与 ‘—copy-to’ 一起使用时才有效）

—keep-init-containers     Default: true

运行 Pod 的初始化容器，默认为 true。 （此标志仅与 ‘—copy-to’ 一起使用时才有效）

—keep-labels

如果为真，则保留原始 Pod 的标签。 （此标志仅与 ‘—copy-to’ 一起使用时才有效）

—keep-liveness

如果为真，则保留原始 Pod 的存活性检测。 （此标志仅与 ‘—copy-to’ 一起使用时才有效）

—keep-readiness

如果为真，则保留原始 Pod 的就绪性探测。 （此标志仅与 ‘—copy-to; 一起使用时才有效）

—keep-startup

如果为真，则保留原始 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 上下文的名称。

—default-not-ready-toleration-seconds int     默认值：300

设置针对 notReady:NoExecute 的容忍度的 tolerationSeconds，默认添加到所有尚未设置此容忍度的 Pod。

—default-unreachable-toleration-seconds int     默认值：300

设置针对 unreachable:NoExecute 的容忍度的 tolerationSeconds，默认添加到所有尚未设置此容忍度的 Pod。

—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”

数据库 host:port

—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 服务器进行身份验证的持有者令牌。

—user string

要使用的 kubeconfig 用户的名称。

—username string

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

—version version[=true]

—version, —version=raw 打印版本信息并退出；—version=vX.Y.Z… 设置报告的版本。

—warnings-as-errors

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

另请参见

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