这是本节的多页打印视图。 点击此处打印.

返回本页常规视图.

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)

    示例

    # 描述一个节点
kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
  
# 描述一个 Pod
kubectl describe pods/nginx
  
# 描述在 "pod.json" 中通过类别和名称标识的 Pod
kubectl describe -f pod.json
  
# 描述所有 Pod
kubectl describe pods
  
# 描述带标签 name=myLabel 的 Pod
kubectl describe pods -l name=myLabel
  
# 描述由 “frontend” 副本控制器管理的所有 Pod
# （副本控制器所创建的 Pod 在 Pod 名称中带有此副本控制器的名称作为前缀）
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

    过滤所用的选择算符（标签查询），支持 '='、'==' 和 '！='。 （例如 -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 客户端密钥文件的路径。

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

    数据库 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 集群管理器