What type of issue is this?
/kind documentation
What happened?
When deploying Grove via helm template | kubectl apply or kustomize (which uses helm template to generate a base), CRDs from the crds/ directory are silently omitted unless --include-crds is passed. Users who don't set crdInstaller.enabled: true and don't know about --include-crds will hit a broken fresh install with no clear error.
GREP-436 (#527) added a "Note for helm template / GitOps users" section in the proposal doc, but the actual chart and user-facing docs don't surface this guidance.
Suggested improvements
- Add a warning in the Helm chart
NOTES.txt when crdInstaller.enabled is false, reminding users about the --include-crds caveat for helm template workflows
- Add comprehensive kustomize installation instructions (base layout with
helm template --include-crds, overlay structure, recommended directory layout)
- Consider documenting a recommended ArgoCD / Flux Application manifest snippet that handles CRDs correctly
Context
Identified during review of #527. The implementation correctly flipped the default to crdInstaller.enabled: false and added the prepare-charts.sh build script, but the UX gap for helm template/kustomize users remains.
What type of issue is this?
/kind documentation
What happened?
When deploying Grove via
helm template | kubectl applyor kustomize (which useshelm templateto generate a base), CRDs from thecrds/directory are silently omitted unless--include-crdsis passed. Users who don't setcrdInstaller.enabled: trueand don't know about--include-crdswill hit a broken fresh install with no clear error.GREP-436 (#527) added a "Note for helm template / GitOps users" section in the proposal doc, but the actual chart and user-facing docs don't surface this guidance.
Suggested improvements
NOTES.txtwhencrdInstaller.enabledis false, reminding users about the--include-crdscaveat forhelm templateworkflowshelm template --include-crds, overlay structure, recommended directory layout)Context
Identified during review of #527. The implementation correctly flipped the default to
crdInstaller.enabled: falseand added theprepare-charts.shbuild script, but the UX gap forhelm template/kustomize users remains.