-
Notifications
You must be signed in to change notification settings - Fork 220
Open
Labels
area/docsDocumentation related issues and pull requestsDocumentation related issues and pull requestsarea/helmHelm related issues and pull requestsHelm related issues and pull requestsarea/ociOCI related issues and pull requestsOCI related issues and pull requests
Description
I'd like to update the Note we have in the HelmRepository type oci API doc section from this:
Note: For improved support for OCI Helm charts, please use the OCIRepository API.
To this:
Note: The
ocitype is in maintenance mode. For improved support for OCI Helm charts, please use the OCIRepository API instead. For more information, see #1955.
Reason
We are constantly advising users to move from HelmRepository type oci to OCIRepository. There are countless Slack threads where we tell the same story:
.spec.chartRefin theHelmReleaseAPI is an optimization over.spec.chart(allows reuse of chart objects)- Users get surprised about the hidden
HelmChartcreated byHelmReleasewith.spec.chartand have a hard time understanding this is actually an optimization .spec.chartRefbrings theHelmReleasedeployment model closer toKustomization(2 objects: 1 source + 1 applier)- Less magic => less confusion
- Our main OCI efforts are focused on
OCIRepository(e.g. Feature Request: SupportOCIRepositoryfor remote dependencies on umbrella charts defined withHelmChartobjects that are built from file trees #1954) - Users get confused by
HelmRepositorytypeocibeing stateless: Helm OCI Repositories should have a ready status #1930 - I have blocked an issue in the Headlamp plugin to improve the support for
HelmRepositorytypeoci: Flux: 🐛 OCI Helm repos are shown as failed on overview headlamp-k8s/plugins#313
It has been raised probably more than once in the Slack threads that the docs should have more emphasis on this move we are asking users to make.
Metadata
Metadata
Assignees
Labels
area/docsDocumentation related issues and pull requestsDocumentation related issues and pull requestsarea/helmHelm related issues and pull requestsHelm related issues and pull requestsarea/ociOCI related issues and pull requestsOCI related issues and pull requests