Get documentation for Kubernetes resources, including field descriptions and structure.
Usage:
ksail workload explain
Examples:
# Get the documentation of the resource and its fields
ksail workload explain pods
# Get all the fields in the resource
ksail workload explain pods --recursive
# Get the explanation for deployment in supported api versions
ksail workload explain deployments --api-version=apps/v1
# Get the documentation of a specific field of a resource
ksail workload explain pods.spec.containers
# Get the documentation of resources in different format
ksail workload explain deployment --output=plaintext-openapiv2
Flags:
--api-version string Get different explanations for particular API version (API group/version)
-h, --help help for explain
-o, --output string Format in which to render the schema (plaintext, plaintext-openapiv2) (default "plaintext")
--recursive Print the fields of fields (Currently only 1 level deep)
Global Flags:
--timing Show per-activity timing output