docs: Add values.schema.json and document the used values - #431
Open
lfrancke wants to merge 1 commit into
Open
Conversation
Follows hive-operator, but written for this chart: it is a CSI driver with a provisioner Deployment and a node driver DaemonSet, so the value surface is its own. 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. The commented "priority" and "preemptionPolicy" examples are dropped: no template reads them, and with the schema in place uncommenting them would now fail instead of being ignored. This also documents all used values in values.yaml itself. NOTES.txt is not part of this since operator-templating#646 generates it.
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.
Description
This follows hive-operator, but is written for this chart rather than copied: it is a CSI driver with a provisioner Deployment and a node driver DaemonSet, so the value surface is its own. Nothing here reads a top-level nodeSelector, tolerations, affinity, resources, podAnnotations, securityContext, podSecurityContext or priorityClassName, so none of those are declared. 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.
The commented
priorityandpreemptionPolicyexamples in values.yaml are dropped, because no template reads either. That was harmless before; with a schema in place, uncommenting one would now fail the install instead of being silently ignored.This also documents all used values in values.yaml itself. NOTES.txt is not part of this since stackabletech/operator-templating#646 generates it.
Definition of Done Checklist
Author
Reviewer
Acceptance
type/deprecationlabel & add to the deprecation scheduletype/experimentallabel & add to the experimental features tracker