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-version(组/版本)。 | |
-h, --help | |
explain 的帮助信息 | |
-o, --output string 默认值: "plaintext" | |
呈现模式的格式。有效值为:(plaintext、plaintext-openapiv2)。 | |
--recursive | |
如果为 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 | |
指示 tolerationSeconds 用于 notReady:NoExecute 的容忍,默认情况下,该容忍会被添加到每个尚未具有此类容忍的 Pod 中。 | |
--default-unreachable-toleration-seconds int 默认值: 300 | |
指示 tolerationSeconds 用于 unreachable:NoExecute 的容忍,默认情况下,该容忍会被添加到每个尚未具有此类容忍的 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 服务器身份验证的 Bearer 令牌 | |
--user string | |
要使用的 kubeconfig 用户的名称 | |
--username string | |
用于 API 服务器的基本身份验证的用户名 | |
--version version[=true] | |
--version, --version=raw 打印版本信息并退出;--version=vX.Y.Z...设置报告的版本 | |
--warnings-as-errors | |
将从服务器收到的警告视为错误,并以非零退出代码退出 |
另请参阅
- kubectl - kubectl 控制 Kubernetes 集群管理器
此页面是自动生成的。
如果您计划报告此页面的问题,请在您的问题描述中提及该页面是自动生成的。修复可能需要在 Kubernetes 项目中的其他地方进行。