This repository has been archived by the owner on Jul 11, 2023. It is now read-only.
feat(charts): validate chart values w/ json schema #1890
Merged
Conversation
This file contains 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
+ add values.schema.json file to indicate which values are required, type, description
nojnhuh
reviewed
Oct 22, 2020
charts/osm/values.schema.json
Outdated
| "type": "object", | ||
| "title": "The OpenServiceMesh schema", | ||
| "description": "The top level required key in the values file.", | ||
| "default": {}, |
There was a problem hiding this comment.
I noticed the example in Helm's docs doesn't include defaults. How much value is there in adding them here? And what could go wrong if these defaults get out of sync with values.yaml?
There was a problem hiding this comment.
That's a really good point. I had them in here because they're an option in json schema but Helm is not using them. Let me go ahead and take them out.
charts/osm/values.schema.json
Outdated
| "type": "string", | ||
| "title": "The envoyLogLevel schema", | ||
| "description": "Envoy log level.", | ||
| "default": "error", |
There was a problem hiding this comment.
A pattern matching the acceptable values might be beneficial here.
nojnhuh
approved these changes
Oct 22, 2020
shashankram
approved these changes
Oct 22, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 PR adds a values.schema.json file to indicate which values are required, type, description, examples, defaults. The schema file will help prevent us from accidentally changing the values file and breaking things as well as ensuring we are specifying the required values any time this chart is installed.
From the docs (https://helm.sh/docs/topics/charts/#schema-files):
Affected area:
Please answer the following questions with yes/no.
No