Clarify Workflow and Contribution Guidelines for values.schema.json Generation in Bitnami Helm Charts

[Jorgagu]

Hi 👋

I’m working on generating a values.schema.json for the sentry-kubernetes/charts repository which using some bitnami charts and I’m running into several challenges:

1. Rollback of Bulk Schema Update
   A recent effort to regenerate all values.schema.json files in the Bitnami Charts repository (see Revert "[bitnami/*] Autogenerate json-schema files for all the charts" charts#19335 was reverted, leaving no clear, up-to-date source of truth for schema generation in the Bitnami workflow.

2. Missing or Out-of-Sync Schemas

   • Some charts in the Sentry Helm repository lack a values.schema.json.
   • Others include one that doesn’t match their values.yaml.
     Running helm lint against these charts triggers validation errors due to these discrepancies.

3. Concrete Example
   In the Bitnami PostgreSQL chart version 16.7.4, the schema defines a property replication.readReplicas (see values.schema.json#L123, but the values.yaml file does not include this key. This mismatch alone causes Helm lint failures.

4. Schema Generation Tool
   To produce the values.schema.json for the Sentry charts, I’m using the dadav/helm-schema helm plugin, which traverses all chart dependencies and overrides any existing values.schema.json with content generated from their corresponding values.yaml files.

5. Open Questions

   • Should we update each Bitnami chart’s values.yaml to include all fields—even those missing but defined in the existing values.schema.json—to avoid these misalignments?
   • What is the recommended best practice for keeping values.yaml and values.schema.json in sync, given this automated process?
   • Since the readme-generator-for-helm tool is responsible for creating values.schema.json, would a PR to update missing fields in the values.yaml be allowed and accepted?
   • I will also submit a request for dadav/helm-schema to not override any existing values.schema.json files during generation.
   • What is the current status of the “full” values.schema.json study mentioned here: [bitnami/rabbitmq] update values.schema.json charts#29095 (comment) ?
   • And what is the progress on the internal issue referenced here: Revert "[bitnami/*] Autogenerate json-schema files for all the charts" charts#19335 (comment) ?

Thanks for your guidance and support!

CC: @carrodher @migruiz4 @fmulero @antgamdia

[github-actions]

This Issue has been automatically marked as "stale" because it has not had recent activity (for 15 days). It will be closed if no further activity occurs. Thanks for the feedback.

[Jorgagu]

Up 👍

[github-actions]

This Issue has been automatically marked as "stale" because it has not had recent activity (for 15 days). It will be closed if no further activity occurs. Thanks for the feedback.

[Jorgagu]

Up 👍