kubectl explain
Synopsis
描述各种资源的字段和结构。
此命令描述了每个支持的 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
Options
| --api-version string | |
为特定 API 版本（API 组/版本）获取不同的解释。 | |
| -h, --help | |
explain 的帮助信息 | |
| -o, --output string 默认值: "plaintext" | |
渲染 schema 的格式（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 上下文名称 | |
| --disable-compression | |
如果为 true，则选择退出所有到服务器的请求的响应压缩 | |
| --insecure-skip-tls-verify | |
如果为 true，则不会检查服务器证书的有效性。这将使您的 HTTPS 连接不安全。 | |
| --kubeconfig string | |
用于 CLI 请求的 kubeconfig 文件路径。 | |
| --kuberc string | |
用于首选项的 kuberc 文件路径。可以通过导出 KUBECTL_KUBERC=false 功能标志或关闭 KUBERC=off 功能来禁用此功能。 | |
| --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 token | |
| --user string | |
要使用的 kubeconfig 用户名 | |
| --username string | |
API 服务器基本身份验证的用户名 | |
| --version version[=true] | |
--version, --version=raw 打印版本信息并退出；--version=vX.Y.Z... 设置报告的版本 | |
| --warnings-as-errors | |
将从服务器收到的警告视为错误，并以非零退出代码退出。 | |
另请参阅
- kubectl - kubectl 控制 Kubernetes 集群管理器
本页面是自动生成的。
如果你打算报告此页面存在的问题，请在问题描述中提及此页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。