[SPARK-52118] Enforce Helm Chart configuration value verification
#196
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
Member
Author
|
cc @jiangzho |
dongjoon-hyun
changed the title
Helm Chart configuration value verification
Member
Author
|
Could you review this PR, @peter-toth ? |
viirya
reviewed
May 14, 2025
| }, | ||
| "digest": { | ||
| "type": "string", | ||
| "description": "Docker image digest, takes precedence over tag if set" |
Member
There was a problem hiding this comment.
tag is required above. But when digest is provided, we don't need tag?
Member
Author
There was a problem hiding this comment.
If both are set, tag will be ignored semantically, but tag field is still required.
viirya
approved these changes
May 14, 2025
peter-toth
approved these changes
May 14, 2025
Contributor
peter-toth
left a comment
peter-toth
left a comment
There was a problem hiding this comment.
Looks good with the current chart:
% helm lint
==> Linting .
1 chart(s) linted, 0 chart(s) failed
But checked with an invalid one as well:
% helm lint
==> Linting .
[ERROR] values.yaml: - image: tag is required
[ERROR] templates/: values don't meet the specifications of the schema(s) in the following chart(s):
spark-kubernetes-operator:
- image: tag is required
Error: 1 chart(s) linted, 1 chart(s) failed
Member
Author
|
Thank you, @viirya and @peter-toth ! |
dongjoon-hyun
added a commit
that referenced
this pull request
May 14, 2025
### What changes were proposed in this pull request? This PR aims to change `Helm Chart` version from `0.2.0-SNAPSHOT` to `1.0.0-dev` and revise the description as a part of official release of this chart `1.0.0`. ### Why are the changes needed? Like [Apache Airflow example](https://github.com/apache/airflow/blob/2d56d2626c84089f156a56137647498a6ad2ee7a/chart/Chart.yaml#L20-L24), `Helm Chart` version is independently managed from the application versions (which is Apache Spark K8s Operator). ```yaml apiVersion: v2 name: airflow version: 1.17.0-dev appVersion: 3.0.0 description: The official Helm chart to deploy Apache Airflow, a platform to programmatically author, schedule, and monitor workflows ``` As a part of the following series of Helm Chart improvement, I believe we are ready to set `1.0.0` for Helm Chart itself at next release, Apache Spark K8s Operator v0.2.0. - #190 - #196 - #191 - #194 ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Pass the CIs and manual review. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #197 from dongjoon-hyun/SPARK-52133. Authored-by: Dongjoon Hyun <[email protected]> Signed-off-by: Dongjoon Hyun <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What changes were proposed in this pull request?
This PR aims to elevate the quality and maintainability of
Helm Chartby introducing a layer of strict validation for user-provided configurations.Why are the changes needed?
By providing
values.schema.jsonfile, we can define and validate the expected configuration values that a user can provide to customize a chart's deployment. This will help the users by preventing mistakes and improving reliability.Does this PR introduce any user-facing change?
No.
How was this patch tested?
Pass the CIs.
Was this patch authored or co-authored using generative AI tooling?
No.