kubectl example - kubectl explain but immediate practical output #5571
Description
Enhancement Description
- kubectl example - kubectl explain but immediate practical output that can be applied | trialed by new user to advanced
think curl cht.sh/kubectl but distributed at cli level - Kubernetes Enhancement Proposal: No PR yet, happy to open if idea is considered solid or useful
- Discussion Link: I have not discussed this within a SIG, as I'd like to prepare proper example
- PRs will be provide by stage and milestone should this issue get some support:
- will require guidance on how to amend the explain output as I've found it extremely useful being cli driven
- my idea is to provide generic seed yaml for different resources - kubectl explain then kubectl example flow
- for instance:
- kubectl explain pod -- detailed explanation of resource
- kubectl example pod -- generic yaml output for a standard pod with linux - alpine image
- potentially also a command like kubectl get pods --all-namespaces
- finally, socialize further the kubectl get --raw on API's and potentially automate ingestion of that to explain what the api controls in flight within a cluster at a version
Please keep this description up to date. This will help the Enhancement Team to track the evolution of the enhancement efficiently.
I'm also quite a bit devops so if you release cats need some help creating a labeling documentation via batching with some key words, I'd like to trial and help that process too. I would have interest in joining the highly competitive release engineering wing in the future, I super enthused by Kat Cosgrove's podcast on pragmatic engineer