kubectl-explain: add page (#18794)

Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> Co-authored-by: Harshavardhan <harshath3018@gmail.com>
2026-08-30 17:33:50 +08:00 · 2025-10-19 20:24:27 +08:00
parent fc5910e465
commit ad2eb877b6
1 changed files with 24 additions and 0 deletions
@@ -0,0 +1,24 @@
+# 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`