kubectl describe

Synopsis

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

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

    $ 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

Options

-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 上下文名称

--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 string     默认值: "none"

要捕获的配置文件名称。选择之一（none|cpu|heap|goroutine|threadcreate|block|mutex）

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