cloud-ark / cloud-ark/kubeplus
Show property comments in kubectl explain of new CRD
- Dominant language
- Go
- Stars
- 756
- Forks
- 95
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 7
Description
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.
Contributor guide
Research direction
Trace the CRD registration path that builds the OpenAPI schema from the Helm chart's values.yaml, starting with how property comments are currently discarded. Verify the result with kubectl explain on a generated CRD; done means comments for Spec attributes are visible while existing schema generation still works.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, helm, kubernetes
- Domain
- infrastructure
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100