docs: Add values.schema.json and NOTES.txt - #935
Open
lfrancke wants to merge 1 commit into
Open
Conversation
This is mostly copied over from hive-operator since the files are not templated. Having a schema makes Helm validate values on install, upgrade, lint and template AND shows as a nice reference on ArtifactHub. One thing to note is that we include the "global" block even if it's not used by us. This is due to https://helm.sh/de/docs/chart_template_guide/subcharts_and_globals/ In short: When used as a subchart Helm injects a "global" into every subchart. If we don't declare it validation will fail when used as a subchart. This also documents all used values in values.yaml itself and adds a NOTES.txt which is displayed automatically after an install.
Techassi
reviewed
Aug 28, 2026
Techassi
left a comment
Techassi
left a comment
Member
There was a problem hiding this comment.
Not templated on purpose.
I can see why the schema is not templated (because the values.yaml file it describes is also not templated), but why is the NOTES.txt file not templated? I don't see anything operator-specific in there (other than its name, which can easily be templated).
Techassi
moved this from Development: Waiting for Review
to Development: In Review
in Stackable Engineering
Member
Author
|
Because it would require special handling for listener, secret and commons. The text would otherwise not fit. "This installs the Stackable operator for Trino only." -> "This installs the Stackable operator for Commons operator only" or similar. |
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.
Ports of
globalthingThis will go into each repository. Not templated on purpose.