website icon indicating copy to clipboard operation
website copied to clipboard

Document that/why we don't use Helm's CRD installation mechanism

Open irbekrm opened this issue 2 years ago • 4 comments

Cert-manager's Helm chart does not use Helm's CRD installation mechanism because it does not allow for CRD update, see https://github.com/helm/community/blob/f9e06c16d89ccea1bea77c01a6a96ae3b309f823/architecture/crds.md

This can cause confusion for folks, see i.e https://kubernetes.slack.com/archives/C4NV3DWUC/p1676635914363249?thread_ts=1676588335.690979&cid=C4NV3DWUC https://github.com/cert-manager/cert-manager/issues/5794

We should document

  • what is the difference (i.e helm show crds doesn't work)
  • why we are doing this

irbekrm avatar Feb 17 '23 12:02 irbekrm

I think I might have covered this, or at least a good attempt to:

  • https://cert-manager.io/docs/installation/helm/#3-install-customresourcedefinitions
  • https://cert-manager.io/docs/installation/helm/#crd-considerations

@irbekrm - appreciate your input if I have covered all the main differences

See: https://github.com/cert-manager/website/pull/1248

hawksight avatar Jul 19 '23 09:07 hawksight

/assign

hawksight avatar Jul 19 '23 10:07 hawksight

Are you still working on this? @hawksight

(it's totally OK if you aren't 😅)

maelvls avatar Jul 16 '24 09:07 maelvls

I actually did document this previously, here: https://cert-manager.io/v1.14-docs/installation/helm/#crd-considerations I think this was removed in v1.15 release due to the change in CRD annotations that were added to the chart?

I guess from a user perspective, do we still behave differently to standard helm and do we document this difference?

hawksight avatar Jul 16 '24 10:07 hawksight