Skip to content

kubectl explain - 资源字段说明文档

基本用法

bash
kubectl explain <资源类>

选项

选项缩写描述示例
--recursive递归显示所有字段及其子字段kubectl explain pod --recursive
--api-version指定要查询的 API 版本kubectl explain deployment --api-version=apps/v1
--include-uninitialized包含未初始化的字段(Kubernetes 1.14+ 已弃用)kubectl explain pod --include-uninitialized
--help-h显示帮助信息kubectl explain --help

经典案例

bash
# 查看 Pod 资源的基本信息
kubectl explain pod
# 查看 Pod 的 spec 字段
kubectl explain pod.spec
# 递归查看 Deployment 的所有字段
kubectl explain deployment --recursive
# 查看特定 API 版本的资源信息
kubectl explain deployment --api-version=apps/v1
# 查看 Pod 中容器相关的字段
kubectl explain pod.spec.containers

输出说明

kubectl explain 的输出通常包含以下信息:

  • KIND: 资源类型
  • VERSION: API 版本
  • DESCRIPTION: 字段描述
  • FIELDS: 子字段列表及其类型