When we work around Kubernetes, we often have to reference the documentation for a few things to save time from the journey from terminal to browser and back. Kubectl offers a great set of help in itself.
Learning about the resources
The command shows all fields from the pod resource along with its type and information about it. You can also look for a subfield.
$ kubectl explain pod $ kubectl explain pod.spec.containers
Sometimes what happens is you know exactly what you want in resource definition, but you forget the field or misspell it,
recursive the flag comes in handy when it shows just the fields along with their type, whether it's a string, map, list, etc.
$ kubectl explain pod --recursive
kubectl explainis pretty useful to know all fields and their type and usage; when you are building some cool stuff like some CLI tool, plugin or maybe operator, you might have to explore and learn about APIs and JSON structures. You can do that with
kubectlright from the terminal,
raw flag for
kubectl get comes in handy for it.
Learning about APIs
kubectl get --raw /
We can also explore the subpath, as shown in the above gif.
- There’s one more command which is quite handy to see what resources are registered in a given kubernetes cluster. It also shows whether a given resource is a namespace or not, and it’s the short names.
I covered this blog post in my keynote talk at Kubernetes Community Days Bangalore keynote as well. For more, watch my talk here:
I hope you learned something new from this blog post. Click here to learn about me and how you can support my work, Thank you.