Skip to content

docs: Add values.schema.json and document the used values - #756

Merged
lfrancke merged 1 commit into
mainfrom
push-mtkoltlrkknv
Sep 15, 2026
Merged

lfrancke merged 1 commit into
mainfrom
push-mtkoltlrkknv

Conversation

@lfrancke

@lfrancke lfrancke commented Sep 11, 2026

Copy link
Copy Markdown
Member

Description

This follows hive-operator roughly but it is the first operator (listener is the other) that is different so some strings are different. I checked all of them and it reads well enough. I'd say it can be waved through but feel free to read the schema!

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

Follows hive-operator, but written for this chart: it is a CSI driver with a
controller Deployment and a node driver DaemonSet, so the value surface is
its own.
Having a schema makes Helm validate values on install, upgrade, lint and
template AND shows as a nice reference on ArtifactHub.
One thing to note is that we include the "global" block even if it's not
used by us. This is due to https://helm.sh/de/docs/chart_template_guide/subcharts_and_globals/
In short: When used as a subchart Helm injects a "global" into every
subchart. If we don't declare it validation will fail when used as a
subchart.
kubernetesClusterDomain and the two priorityClassName keys are read by the
templates but were missing from values.yaml, so they are documented there now.
This also documents all used values in values.yaml itself.
NOTES.txt is not part of this since operator-templating#646 generates it.
@lfrancke lfrancke self-assigned this Sep 14, 2026
@lfrancke lfrancke moved this to Development: Waiting for Review in Stackable Engineering Sep 14, 2026
@Techassi Techassi moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Sep 15, 2026
@lfrancke
lfrancke added this pull request to the merge queue Sep 15, 2026
@lfrancke lfrancke moved this from Development: In Review to Development: Done in Stackable Engineering Sep 15, 2026
Merged via the queue into main with commit 5f6d3e4 Sep 15, 2026
28 of 33 checks passed
@lfrancke
lfrancke deleted the push-mtkoltlrkknv branch September 15, 2026 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Development: Done

Development

Successfully merging this pull request may close these issues.

2 participants