Add Helm values schema to all charts #643
Open
Conversation
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
sd109
force-pushed
the
feat/helm-values-schema
branch
from
111c165 to
d3e83a0
Compare
sd109
changed the title
Schemas generated using https://github.com/dadav/helm-schema by running the following commands from the repo root: ``` helm plugin install https://github.com/dadav/helm-schema helm schema ``` and then refining the generated schema using @Schema comments in the relevant values.yaml files.
Moving test values into ci/ folder allows ct lint command to use the same values. Linting also validates against the new JSON schema and therefore needs fields such as kubernetesVersion to be non-null.
sd109
force-pushed
the
feat/helm-values-schema
branch
from
164f73b to
c4582e4
Compare
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.
The values files in these charts are growing increasingly complex and it's easy to accidentally miss some indentation or make a typo when setting Helm values. Helm includes built-in support for validating a values file format against a provided JSON schema which can help avoid trivial config errors.
This change adds a values schema generated using the helm-schema plugin and adds appropriate
@schemaannotations to the values files to constrain the schema for config options which cannot be automatically inferred from their default values.