kubectl-explain

shows resource and field documentation

TLDR

Explain resource

$ kubectl explain [pod]

Explain field

$ kubectl explain [pod.spec]

Explain nested field

$ kubectl explain [pod.spec.containers]

Show recursive structure

$ kubectl explain [pod] --recursive

Explain specific API version

$ kubectl explain [deployment] --api-version=[apps/v1]

SYNOPSIS

kubectl explain [options] resource

kubectl explain shows resource and field documentation. It displays the schema for Kubernetes objects.The command helps write manifests correctly. It shows field types, defaults, and descriptions.

PARAMETERS

RESOURCE

Resource type and optional field path.

--recursive

Show all fields recursively.

--api-version VERSION

Explain specific API version.

--help

Display help information.

INSTALL

sudo apt install kubectl

sudo pacman -S kubectl

sudo apk add kubectl

brew install kubectl

nix profile install nixpkgs#kubectl

CAVEATS

Subcommand of kubectl. Documentation from API server. Varies by Kubernetes version.

HISTORY

kubectl explain provides built-in API documentation for Kubernetes resource authoring.