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 以禁用。此标志处于测试阶段，将来可能会更改。

-f, --filename strings

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

-h, --help

describe 的帮助信息

-k, --kustomize string

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

-R, --recursive

递归处理 -f、--filename 中使用的目录。当您希望管理同一个目录中组织的相关清单时，此选项非常有用。

-l, --selector string

选择器（标签查询），用于过滤，支持“=”、“==”和“!=”。（例如 -l key1=value1,key2=value2）。匹配的对象必须满足所有指定的标签约束。

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

--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 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 服务器进行身份验证的承载令牌

--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：更新 kubectl 参考以使用 v1.30 (a6ccd20be9)