kubectl explain
kubectl explain 是 Kubernetes 的官方内置文档工具,也被称为“自学神器”。当你忘记某个资源的字段定义、数据类型或嵌套结构时,不需要去浏览器搜索官方 API 文档,直接在命令行就能查询。它的核心作用是:获取资源及其字段的文档说明。
以下是该命令的详细用法和实战技巧:
2. 常用场景与示例
📖 查看资源顶层结构
当你想知道一个资源(如 Pod 或 Deployment)有哪些一级字段时:
# 查看 Pod 的基本字段 (apiVersion, kind, metadata, spec, status)
kubectl explain pod
# 查看 Deployment 的基本字段
kubectl explain deployment
查看具体字段详情
当你编写 YAML 文件,不确定某个字段(如
replicas 或 image)的具体定义或数据类型时:# 查看 Pod 的 spec 字段说明
kubectl explain pod.spec
# 查看 Pod 中容器的定义
kubectl explain pod.spec.containers
# 查看 Deployment 的副本数字段
kubectl explain deployment.spec.replicas
递归查看所有字段 (--recursive)
这是最强大的用法。如果你想一次性查看某个资源下所有可用的字段(包括深层嵌套的),可以加上
--recursive 参数。# 列出 Pod 的所有字段(输出会非常长,建议配合 less 使用)
kubectl explain pod --recursive | less
# 列出 Deployment spec 下的所有字段
kubectl explain deployment.spec --recursive
欢迎来撩 : 汇总all
