docs: Add NOTES.txt and document the values only the schema mentioned - #753
Merged
Conversation
lfrancke
force-pushed
the
push-yuuvxpvplorx
branch
2 times, most recently
from
August 21, 2026 16:30
d937d32 to
98dc381
Compare
dervoeti
previously approved these changes
Aug 27, 2026
dervoeti
moved this from Development: Waiting for Review
to Development: In Review
in Stackable Engineering
helm show values does not read values.schema.json and there is no helm show schema, so image.repository, image.productRepository, image.tag and priorityClassName could not be discovered from the CLI at all. They are added to values.yaml as commented examples, the convention the file already uses. No chart printed anything after helm install. NOTES.txt now says what was installed and where the documentation is, explains why no CRDs appear, and warns when maintenance.customResourceDefinitions.maintain is false, where the chart ships no CRDs and the operator does not create them either. Declares global in the schema. Helm injects global into every subchart's values before validating them, even when the parent chart sets none, so additionalProperties: false at the root made this chart fail to render inside any umbrella chart. The chart does not read the value. Reported on kafka-operator#1013. nodeSelector, tolerations and affinity place the operator pod only, which the resources description already says for sizing and these three did not say for placement. Corrects the serviceAccount.name comment, which described the behaviour from before #742.
lfrancke
force-pushed
the
push-yuuvxpvplorx
branch
from
August 27, 2026 20:24
98dc381 to
a62ef84
Compare
Member
Author
|
Applied the same |
lfrancke
enabled auto-merge
August 28, 2026 06:53
dervoeti
approved these changes
Aug 28, 2026
lfrancke
moved this from Development: In Review
to Development: Done
in Stackable Engineering
github-merge-queue
Bot
removed this pull request from the merge queue due to no response for status checks
Aug 28, 2026
This was referenced Aug 28, 2026
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.
Two "documentation" things:
NOTEST.txtfile: This is printed to stdout after every installation usinghelm installhelm show valuesshows the values file but not the schema. We already document some of the properties in a "commented" out fashion. This also adds the remaining ones so they are easier to discover