HIP: separate OCI pull identity from chart identity - #443
Open
BeganovR wants to merge 1 commit into
Open
Conversation
For OCI dependencies, dependencies[].name in Chart.yaml has to serve as both chart identity (checked by helm lint against the vendored subchart's own name) and OCI pull basename. When a chart is published or mirrored under a registry path whose basename differs from its own name, there's no way to satisfy both roles, and helm lint fails with a paired error/warning after helm dependency update succeeds. This proposes an optional artifactName field on dependencies[] that carries the OCI pull basename separately from name, so name always represents chart identity. Fully additive and backward compatible. See helm/helm#32529 Signed-off-by: BeganovR <446110@niuitmo.ru>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds a HIP proposing an optional
artifactNamefield ondependencies[]entries inChart.yaml, so the OCI pull basename can be set separately from the chart's own identity (name).Today
dependencies[].namehas to double as both the chart identity checked byhelm lintagainst the vendored subchart's ownChart.yamlname, and the basename Helm appends to build the OCI pull reference (oci://<repo>/<name>:<version>). When a chart is published or mirrored under a registry path whose basename differs from its own name (common with registry mirroring or org naming prefixes), there's no way to satisfy both roles at once:helm dependency updatecan pull the chart, buthelm lintthen fails with a paired error/warning.The proposed field is opt-in and backward compatible: if unset, the pull basename still falls back to
nameexactly as today.Fixes/addresses helm/helm#32529, where this was discussed and a HIP was requested before implementation.
A reference implementation exists locally covering
pkg/chart/v2/dependency.go,pkg/downloader/manager.go, andinternal/resolver/resolver.go, with unit and end-to-end test coverage. That PR against helm/helm will follow once this HIP has been reviewed.Test plan