kubectl describe

概要

显示特定资源或资源组的详细信息。

打印所选资源的详细描述，包括事件或控制器等相关资源。你可以按名称选择单个对象，或者选择该类型的所有对象，也可以提供名称前缀或标签选择器。例如：

    $ kubectl describe TYPE NAME_PREFIX

将首先检查 TYPE 和 NAME_PREFIX 的精确匹配。如果不存在此类资源，则将输出名称以 NAME_PREFIX 开头的每个资源的详细信息。

使用 "kubectl api-resources" 查看所有支持的资源列表。

kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)

示例

  # Describe a node
  kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
  
  # Describe a pod
  kubectl describe pods/nginx
  
  # Describe a pod identified by type and name in "pod.json"
  kubectl describe -f pod.json
  
  # Describe all pods
  kubectl describe pods
  
  # Describe pods by label name=myLabel
  kubectl describe pods -l name=myLabel
  
  # Describe all pods managed by the 'frontend' replication controller
  # (rc-created pods get the name of the rc as a prefix in the pod name)
  kubectl describe pods frontend

选项

-A, --all-namespaces

如果设置，列出跨所有命名空间请求的对象。即使使用 --namespace 指定了命名空间，当前上下文中的命名空间也会被忽略。

--chunk-size int     默认值: 500

分块返回大型列表，而不是一次性全部返回。传 0 禁用。此标志为 beta 版，将来可能会更改。

-f, --filename strings

包含要描述的资源的文件、目录或 URL

-h, --help

describe 命令的帮助信息

-k, --kustomize string

处理 kustomization 目录。此标志不能与 -f 或 -R 一起使用。

-R, --recursive

递归处理 -f, --filename 中使用的目录。当你希望管理组织在同一目录中的相关清单时很有用。

-l, --selector string

用于过滤的选择器（标签查询），支持 '=', '==', '!=', 'in', 'notin'。（例如：-l key1=value1,key2=value2,key3 in (value3)）。匹配的对象必须满足所有指定的标签约束。

--show-events     默认值: true

如果为 true，则显示与所描述对象相关的事件。

继承自父命令的选项

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

表示默认添加到每个尚未拥有此类容忍度的 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 server 进行基本认证的密码

--profile string     默认值: "none"

要捕获的 profile 名称。取值范围：(none|cpu|heap|goroutine|threadcreate|block|mutex)

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

写入 profile 的文件名称

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

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

-s, --server string

Kubernetes API server 的地址和端口

--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 server 进行认证的 Bearer Token

--user string

要使用的 kubeconfig 用户名称

--username string

对 API server 进行基本认证的用户名

--version version[=true]

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

--warnings-as-errors

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

参见

  • kubectl - kubectl 用于管理 Kubernetes 集群。

本页面是自动生成的。

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

上次修改时间：2025 年 4 月 24 日 上午 8:03 (PST)：kubectl reference for v1.33 (80481646c3)