mirror of
https://github.com/ivuorinen/cheatsheet-tldr.git
synced 2026-02-03 21:43:35 +00:00
30 lines
749 B
Plaintext
30 lines
749 B
Plaintext
---
|
|
syntax: markdown
|
|
tags: [tldr, common]
|
|
source: https://github.com/tldr-pages/tldr.git
|
|
---
|
|
# kubectl explain
|
|
|
|
> Display the documentation of a Kubernetes API resource, including available fields and descriptions.
|
|
> More information: <https://kubernetes.io/docs/reference/kubectl/generated/kubectl_explain/>.
|
|
|
|
- Show documentation for a resource:
|
|
|
|
`kubectl explain {{pods|nodes|deployments|...}}`
|
|
|
|
- Show documentation for a sub-resource or field of an object:
|
|
|
|
`kubectl explain {{pod.spec.containers}}`
|
|
|
|
- Show documentation for a specific versioned resource:
|
|
|
|
`kubectl explain {{ingress.v1.networking.k8s.io}}`
|
|
|
|
- Show all fields recursively for a resource:
|
|
|
|
`kubectl explain {{[po|pods]}} --recursive`
|
|
|
|
- Display help:
|
|
|
|
`kubectl explain --help`
|