docs: Add values.schema.json and NOTES.txt - #1013
Open
lfrancke wants to merge 1 commit into
Open
Conversation
Ports what hive-operator has, since both charts read the same values. values.schema.json makes Helm validate values on install, upgrade, lint and template, and gives Artifact Hub a values reference. additionalProperties is false, with the surface taken from what the templates read rather than from values.yaml, because four keys are read but were never declared there. helm show values does not read the 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. Nothing was printed 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.
lfrancke
force-pushed
the
push-qkqtxxpxslum
branch
from
August 21, 2026 16:30
5a4d910 to
3e3d9e8
Compare
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
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 what hive-operator got in #743 and #753, so this is the second of sixteen. It adds three things, all documentation or validation — no behavioural change.
values.schema.json— Helm validates values against it on install, upgrade, lint and template, and Artifact Hub renders it as a values reference.additionalPropertiesisfalse, with the surface taken from what the templates actually read rather than fromvalues.yaml.NOTES.txt— no SDP chart has one, sohelm installcurrently prints nothing. It also explains why no CRDs appear (they moved out of the chart, sokubectl get crdright after installing looks like a failed install), and warns whenmaintenance.customResourceDefinitions.maintainis false, where the chart ships no CRDs and the operator will not create them — currently a silent trap.Four values documented in
values.yaml—image.repository,image.productRepository,image.tagandpriorityClassNameare read by the templates but were absent fromvalues.yaml. Sincehelm show valuesdoes not read the schema, they were invisible from the CLI, so someone pulling from a mirror had no way to discoverimage.repository.Why the schema can be hive's with names substituted
The chart reads exactly the same values as hive's. Verified by extracting every
.Values.*reference from every template in both charts and diffing: identical.values.yamldiffers from hive's by one line, the header comment.Verification
main, so nothing changes for an existing installhelm lintclean against both registry overlays, so the schema accepts the shippedvalues.yaml--set priorityClassNam=oopsnow fails withadditional properties 'priorityClassNam' not allowedimage.tagreaches the image reference,productRepositoryreaches theIMAGE_REPOSITORYenv var,priorityClassNamereaches the pod specNOTES.txtrendered withmaintainboth true and false