kubectl explain
概要
描述各种资源的字段和结构。
此命令描述与每个受支持的 API 资源关联的字段。字段通过简单的 JSONPath 标识符进行标识
<type>.<fieldName>[.<fieldName>]
有关每个字段的信息以 OpenAPI 格式从服务器检索。
使用“kubectl api-resources”获取受支持资源的完整列表。
kubectl explain TYPE [--recursive=FALSE|TRUE] [--api-version=api-version-group] [--output=plaintext|plaintext-openapiv2]
示例
# Get the documentation of the resource and its fields
kubectl explain pods
# Get all the fields in the resource
kubectl explain pods --recursive
# Get the explanation for deployment in supported api versions
kubectl explain deployments --api-version=apps/v1
# Get the documentation of a specific field of a resource
kubectl explain pods.spec.containers
# Get the documentation of resources in different format
kubectl explain deployment --output=plaintext-openapiv2
选项
| --api-version 字符串 | |
使用资源的给定 api 版本（组/版本）。 | |
| -h, --help | |
explain 的帮助 | |
| --output 字符串 默认值：“plaintext” | |
渲染架构的格式。有效值为：(plaintext, plaintext-openapiv2)。 | |
| --recursive | |
如果为 true，则递归打印所有字段的名称。否则，打印可用字段及其描述。 | |
| --as 字符串 | |
要为操作模拟的用户名。用户可以是命名空间中的普通用户或服务帐户。 | |
| --as-group 字符串 | |
要为操作模拟的组，此标志可以重复指定多个组。 | |
| --as-uid 字符串 | |
要为操作模拟的 UID。 | |
| --cache-dir 字符串 默认值：“$HOME/.kube/cache” | |
默认缓存目录 | |
| --certificate-authority 字符串 | |
证书颁发机构的证书文件路径 | |
| --client-certificate 字符串 | |
TLS 的客户端证书文件路径 | |
| --client-key 字符串 | |
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 字符串 | |
要使用的 kubeconfig 集群的名称 | |
| --context 字符串 | |
要使用的 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 字符串 | |
用于 CLI 请求的 kubeconfig 文件的路径。 | |
| --match-server-version | |
要求服务器版本与客户端版本匹配 | |
| -n, --namespace 字符串 | |
如果存在，则为此 CLI 请求的命名空间范围 | |
| --password 字符串 | |
用于对 API 服务器进行基本身份验证的密码 | |
| --profile 字符串 默认值：“none” | |
要捕获的配置文件的名称。以下之一（none|cpu|heap|goroutine|threadcreate|block|mutex） | |
| --profile-output 字符串 默认值：“profile.pprof” | |
要将配置文件写入的文件的名称 | |
| --request-timeout 字符串 默认值：“0” | |
放弃单个服务器请求之前等待的时间长度。非零值应包含相应的时间单位（例如 1s、2m、3h）。值为零表示不超时请求。 | |
| -s, --server 字符串 | |
Kubernetes API 服务器的地址和端口 | |
| --storage-driver-buffer-duration 持续时间 默认值：1m0s | |
存储驱动程序中的写入将缓冲此持续时间，并作为单个事务提交到非内存后端 | |
| --storage-driver-db 字符串 默认值：“cadvisor” | |
数据库名称 | |
| --storage-driver-host 字符串 默认值：“localhost:8086” | |
数据库主机：端口 | |
| --storage-driver-password 字符串 默认值：“root” | |
数据库密码 | |
| --storage-driver-secure | |
使用与数据库的安全连接 | |
| --storage-driver-table 字符串 默认值：“stats” | |
表名 | |
| --storage-driver-user 字符串 默认值：“root” | |
数据库用户名 | |
| --tls-server-name 字符串 | |
用于服务器证书验证的服务器名称。如果未提供，则使用用于联系服务器的主机名 | |
| --token 字符串 | |
用于对 API 服务器进行身份验证的 Bearer 令牌 | |
| --user 字符串 | |
要使用的 kubeconfig 用户的名称 | |
| --username 字符串 | |
用于对 API 服务器进行基本身份验证的用户名 | |
| --version 版本[=true] | |
--version, --version=raw 打印版本信息并退出；--version=vX.Y.Z... 设置报告的版本 | |
| --warnings-as-errors | |
将从服务器收到的警告视为错误，并以非零退出代码退出 | |
另请参阅
- kubectl - kubectl 控制 Kubernetes 集群管理器
此页面是自动生成的。
如果您计划报告此页面的问题，请在问题描述中提及该页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。