docs(helm): clarify auto-resolve behavior in chart values comments#1477
Merged
Merged
Conversation
The values.yaml comments for `database.postgres.host` and `store.oci.registry_address` gave an incomplete (and in one place actively misleading) picture of how the chart handles host/address resolution. Specifically: - The Database configuration block stated "Users must specify ALL values explicitly - there is no auto-detection", but `chart.postgres.host` in apiserver/templates/_helpers.tpl auto-resolves to the bundled subchart's Service when postgresql.enabled=true. - The OCI store comments did not mention that `chart.oci.registryAddress` auto-resolves to the bundled Zot subchart, or that repository_name defaults to "dir" in that case. Update the comments to describe what the chart actually does: explicit value wins, otherwise auto-resolve from the subchart. No behavior change. Signed-off-by: Krunal Sabnis <211486092+z-krunal@users.noreply.github.com>
ramizpolic
approved these changes
May 9, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
2 participants
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
Updates
install/charts/dir/values.yamlcomments to accurately describethe chart's auto-resolve behavior for PostgreSQL host and OCI registry
address. Comment-only changes; no chart behavior change.
Why
The current values.yaml states:
But the helpers in
apiserver/templates/_helpers.tpldo auto-detect:chart.postgres.hostreturns<release>-postgresql.<ns>.svc.cluster.localwhenpostgresql.enabled=trueand no explicit host is setchart.oci.registryAddressreturns the bundled Zot service whenzot.enabled=truechart.oci.repositoryNamedefaults to"dir"whenzot.enabled=trueand the field is emptyHit this while installing dir for the first time — I set host explicitly
per the comment, then later noticed the chart would have auto-resolved it.
Updating the comments so the next person doesn't trip on the same thing.
Changes
database.postgres.hostfield commentstore.oci.registry_address/repository_name(these didn't lie, but were silent about the helper behavior)Verification
Default helm install:
Works without any host or registry_address override, confirming the
helpers auto-resolve. No keys, defaults, or runtime behavior changed —
no tests affected.