kubectl explain
概要
描述各种资源的字段和结构。
此命令描述每个受支持的 API 资源关联的字段。字段通过简单的 JSONPath 标识符来识别
<type>.<fieldName>[.<fieldName>]
关于每个字段的信息从服务器以 OpenAPI 格式检索。
使用 "kubectl api-resources" 命令查看受支持的资源完整列表。
kubectl explain TYPE [--recursive=FALSE|TRUE] [--api-version=api-version-group] [-o|--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 string | |
获取特定 API 版本（API 组/版本）的不同解释。 | |
| -h, --help | |
explain 命令帮助 | |
| --output string 默认值: "plaintext" | |
渲染模式的格式 (plaintext, plaintext-openapiv2)。 | |
| --recursive | |
打印字段的子字段（当前仅支持 1 层深度）。 | |
继承的父级选项
| --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 服务器基本认证的密码。 | |
| --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 令牌。 | |
| --user string | |
要使用的 kubeconfig 用户名称。 | |
| --username string | |
用于 API 服务器基本认证的用户名。 | |
| --version version[=true] | |
--version 或 --version=raw 输出版本信息并退出；--version=vX.Y.Z... 设置报告的版本。 | |
| --warnings-as-errors | |
将从服务器收到的警告视为错误，并以非零退出码退出。 | |
参见
- kubectl - kubectl 控制 Kubernetes 集群管理器。
此页面是自动生成的。
如果您打算报告此页面上的问题，请在问题描述中说明该页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。