Skip to content

Stop recommending to put CRDs under templates - #1616

Open
matheuscscp wants to merge 1 commit into
mainfrom
stop-templating-crds
Open

matheuscscp wants to merge 1 commit into
mainfrom
stop-templating-crds

Conversation

@matheuscscp

@matheuscscp matheuscscp commented Oct 16, 2026 •

Copy link
Copy Markdown
Member

Issues coming from putting CRDs under templates:

I'm gonna file docs improvements in Helm upstream too to fix this, both of us should stop recommending this workaround, because ecosystem components are doing it, and they shouldn't ship their charts based on cheap workarounds. Edit:

@matheuscscp matheuscscp added area/docs Documentation related issues and pull requests backport:release/v1.6.x To be backported to release/v1.6.x labels Oct 16, 2026
matheuscscp added a commit to matheuscscp/helm-www that referenced this pull request Oct 16, 2026
HIP-0011 mentions that templating support for CRDs in *Helm 3* is kept only for backward compatibility with Helm 2:

https://helm.sh/community/hips/hip-0011/#installing-crds

> NOTE: There is no requirement that CRDs can only be placed in the `crds/` directory. They can be put along side other resources in the `templates/` directory. This was an intentional design choice to preserve backward compatibility.

Helm 4 should have removed that support, since it was no longer required to keep compatibility with Helm 2. I'm gonna file a HIP for removing support in Helm 5.

Problems caused by the recommendation being removed in this PR:

* fluxcd/helm-controller#1601
* controlplaneio-fluxcd/terraform-kubernetes-flux-operator-bootstrap#102

And many more in Flux that I don't have the time to find.

We are also removing this recommendation from the Flux HelmRelease docs:

fluxcd/helm-controller#1616

Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>
TerryHowe added a commit to helm/helm-www that referenced this pull request Oct 17, 2026
HIP-0011 mentions that templating support for CRDs in *Helm 3* is kept only for backward compatibility with Helm 2:

https://helm.sh/community/hips/hip-0011/#installing-crds

> NOTE: There is no requirement that CRDs can only be placed in the `crds/` directory. They can be put along side other resources in the `templates/` directory. This was an intentional design choice to preserve backward compatibility.

Helm 4 should have removed that support, since it was no longer required to keep compatibility with Helm 2. I'm gonna file a HIP for removing support in Helm 5.

Problems caused by the recommendation being removed in this PR:

* fluxcd/helm-controller#1601
* controlplaneio-fluxcd/terraform-kubernetes-flux-operator-bootstrap#102

And many more in Flux that I don't have the time to find.

We are also removing this recommendation from the Flux HelmRelease docs:

fluxcd/helm-controller#1616

Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>
Co-authored-by: Terry Howe <terrylhowe@gmail.com>
@matheuscscp matheuscscp removed the backport:release/v1.6.x To be backported to release/v1.6.x label Oct 18, 2026
Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation related issues and pull requests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant