feat: Add values.schema.json - #743
Open
lfrancke wants to merge 1 commit into
Open
Conversation
Helm validates values against this on install, upgrade, template and lint. Today a This can help prevent typos like `--set telemtry.consoleLog.enabled=false` and similar things. Artifact Hub also renders it as a browsable values reference and we want to show it in our own Hub later as well. This is based off what the templates actually read, not only values.yaml
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.
Description
Important
This builds on top of #742 and describes the fixed scenario from that PR. Strictly speaking that one should be reviewed and merged first but in reality it doesn't matter.
Note
This PR serves as a "template" for all the other operators. If this is accepted I'll do the same for the other operators.
Helm validates values against this on install, upgrade, template and lint. Today a This can help prevent typos like
--set telemtry.consoleLog.enabled=falseand similar things.Artifact Hub also renders it as a browsable values reference and we want to show it in our own Hub later as well.
This is based off what the templates actually read, not only values.yaml
Note
Similar to #742 the CI stuff in here will later be merged into operator-templating.
Definition of Done Checklist
Author
Reviewer
Acceptance
type/deprecationlabel & add to the deprecation scheduletype/experimentallabel & add to the experimental features tracker