optim: trim descriptions in fluid crds to avoid touching size limit in helm release storage #5251
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.



Ⅰ. Describe what this PR does
Fluid is usually installed by Helm. When helm installs/upgrades a helm release, it generates a Kubernetes Secret resource to store all the compressed release data(including CRD specifications) in it. Kubernetes has a size limit on the stored data in a Secret resource (normally 1M). Fluid may touch the size limit when we are introducing more and more Fluid CRDs to the helm chart.
Currently, the size of the compressed data of a Fluid helm release is about 880K, which is approaching the limit (1.0M)
This PR follows common solutions proposed in community (Kubebuilder FAQ, Kubernetes#82292) to trim all descriptions in the CRD to make CRD size smaller.
After trimming all the description, we see the size of the compressed data lowers down to ~160K:
NOTE: trimming all the descriptions brings side effects:
kubectl explainwill no longer "explain" the meaning of each field. USERS should refer to Fluid's API Doc for field references.Ⅱ. Does this pull request fix one issue?
NONE
Ⅲ. List the added test cases (unit test/integration test) if any, please explain if no tests are needed.
Ⅳ. Describe how to verify it
Ⅴ. Special notes for reviews