Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show property comments in kubectl explain of new CRD #1139

Open
Tracked by #683
devdattakulkarni opened this issue Mar 24, 2023 · 1 comment
Open
Tracked by #683

Show property comments in kubectl explain of new CRD #1139

devdattakulkarni opened this issue Mar 24, 2023 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@devdattakulkarni
Copy link
Contributor

KubePlus generates OpenAPI schema from values.yaml of the helm chart when registering the CRD.
Right now we are ignoring the comments in the values.yaml. Because of this when we use 'kubectl explain' on the CRD, we do not see any comments about the attributes in the Spec definition. We should update the CRD registration to use the comments available in values.yaml when registering the OpenAPI schema definition.

As an alternative, you can use the 'kubectl man' plugin. It displays the values.yaml as part of the spec properties of CRD.

@devdattakulkarni
Copy link
Contributor Author

This requires understanding of OpenAPI schema, how it is used in Kubernetes, and how KubePlus is generating the OpenAPI schema for the generated CRD.

KubePlus specific changes will be in deploy/kubeconfiggenerator.py, specifically the "registercrd" method.

@devdattakulkarni devdattakulkarni added enhancement New feature or request help wanted Extra attention is needed labels Apr 16, 2024
@devdattakulkarni devdattakulkarni mentioned this issue May 14, 2024
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant