docs: document literal field on valuesFrom - #1503
Merged
Merged
Conversation
gecube
force-pushed
the
feat/valuesfrom-literal
branch
from
May 25, 2026 10:23
5b1c0b8 to
564f026
Compare
Member
The OpenAPI schema for the new `literal` field on `valuesFrom` entries landed via the CRD regeneration in fluxcd#1506 (k8s 1.36 / Go 1.26 bump, which picked up the corresponding field from the regenerated meta package). This commit ships only the matching user-facing documentation in docs/spec/v2/helmreleases.md. The runtime support lives in fluxcd/pkg/chartutil (fluxcd/pkg#1218); once that merges and a release is cut, a follow-up here will bump the dependency so helm-controller actually honours the field. Until then, setting `literal: true` is accepted by the API but has no effect. Addresses fluxcd#1317. Closes fluxcd/flux2#2625. Signed-off-by: George Gaál <gb12335@gmail.com>
gecube
force-pushed
the
feat/valuesfrom-literal
branch
from
June 4, 2026 14:41
564f026 to
b98cd99
Compare
gecube
changed the title
Contributor
Author
|
@matheuscscp done. thanks. |
7 tasks
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.
Closes: fluxcd/flux2#2625
Adds the user-facing documentation for the new
literalfield onvaluesFromentries.Context
The new field has two parts:
config/crd/bases/helm.toolkit.fluxcd.io_helmreleases.yaml— already landed via Update to Kubernetes 1.36 and Go 1.26 #1506 (k8s 1.36 / Go 1.26 bump regenerated the CRD and picked up theLiteralfield from the meta package).fluxcd/pkg/chartutil— in flight as fluxcd/pkg#1218. Once that merges and a release is cut, a follow-up here will bump the dependency so helm-controller actually honours the field.This PR fills in the missing third piece: the user-facing reference in
docs/spec/v2/helmreleases.md. Until pkg ships, settingliteral: trueis accepted-but-ignored — forward-compatible behaviour.Motivation
valuesFromwithtargetPathruns the referenced value throughstrvals.ParseInto— the same parser ashelm --set. Anything containing,,[,],{,}or unescaped=is interpreted as Helm-set syntax, so arbitrary file content (Springapplication.ymlwith flow sequences, HOCONapplication.conf, JSON blobs, multi-line YAML, …) is misparsed or fails outright. Examples in the wild:The quote-wrap workaround from #298 is impractical when content arrives via Kustomize
configMapGenerator/secretGenerator(raw file → raw bytes in the CM, no opportunity to wrap). Flux's kustomize-controller disables Kustomize plugins so a generator/transformer-based wrap is also off the table.What's in this PR
literal(Optional) bullet in thevaluesFromsubkey list.literal: truewith a kustomize-style raw file payload.valuesFromsection pointing users toliteral: truewhen their content contains,,[,],{,},=.Resolves
fluxcd/helm-controller#1317. Addresses parts of #460, #853, flux2#1756.