Skip to content

feat: Add values.schema.json - #743

Open
lfrancke wants to merge 1 commit into
mainfrom
push-mpowrmmkmuwt
Open

feat: Add values.schema.json#743
lfrancke wants to merge 1 commit into
mainfrom
push-mpowrmmkmuwt

Conversation

@lfrancke

@lfrancke lfrancke commented Aug 8, 2026

Copy link
Copy Markdown
Member

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=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

Note

Similar to #742 the CI stuff in here will later be merged into operator-templating.

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes

Author

  • Changes are OpenShift compatible
  • CRD changes approved
  • CRD documentation for all fields, following the style guide.
  • Helm chart can be installed and deployed operator works
  • Integration tests passed (for non trivial changes)
  • Changes need to be "offline" compatible
  • Links to generated (nightly) docs added
  • Release note snippet added

Reviewer

  • Code contains useful comments
  • Code contains useful logging statements
  • (Integration-)Test cases added
  • Documentation added or updated. Follows the style guide.
  • Changelog updated
  • Cargo.toml only contains references to git tags (not specific commits or branches)

Acceptance

  • Feature Tracker has been updated
  • Proper release label has been added
  • Links to generated (nightly) docs added
  • Release note snippet added
  • Add type/deprecation label & add to the deprecation schedule
  • Add type/experimental label & add to the experimental features tracker

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
@lfrancke lfrancke self-assigned this Aug 8, 2026
@lfrancke lfrancke moved this to Development: Waiting for Review in Stackable Engineering Aug 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Development: Waiting for Review

Development

Successfully merging this pull request may close these issues.

1 participant