kubectl explain
简介
描述各种资源的字段和结构。
此命令描述与每个被支持的 API 资源关联的字段。 这些字段通过一个简单的 JSONPath 标识符进行识别：
<类型>.<字段名>[.<字段名>]
有关每个字段的信息是以 OpenAPI 格式从服务器中检索而来的。
使用 "kubectl api-resources" 获取受支持的资源的完整列表。
kubectl explain TYPE [--recursive=FALSE|TRUE] [--api-version=api-version-group] [--output=plaintext|plaintext-openapiv2]
示例
# 获取资源及其字段的文档
kubectl explain pods
# 获取资源中的所有字段
kubectl explain pods --recursive
# 获取被支持的 API 版本中 Deployment 的解释
kubectl explain deployments --api-version=apps/v1
# 获取资源中特定字段的文档
kubectl explain pods.spec.containers
# 获取资源的不同格式的文档
kubectl explain deployment --output=plaintext-openapiv2
选项
| --api-version string | |
使用资源的给定的 API 版本（组/版本）。 | |
| -h, --help | |
explain 操作的帮助命令。 | |
| --output string 默认值："plaintext" | |
渲染模式的格式。有效值为：（plaintext、plaintext-openapiv2）。 | |
| --recursive | |
如果为真，递归打印所有字段的名称。否则，打印可用字段及其描述。 | |
| --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 集群控制器