Locking Helm Chart Version in values.yaml

Lock your values file to a specific Helm chart version to prevent accidental upgrades or version mismatches.

All Cybus Helm charts support an optional validVersion value that ties your values.yaml file to a specific chart version. When set, Helm refuses to render templates if the chart version does not match the specified value.

This prevents accidental deployments with mismatched chart versions, such as when upgrading the chart without updating your values file accordingly.

The validVersion check is opt-in. If not set, no version validation is performed.

How Version Locking Works

During template rendering, the chart compares validVersion against the chart's version. If they differ, Helm fails immediately with an error message. This provides an early signal that your values file was written for a different chart version and may need review before proceeding.

Error message

Error: INSTALLATION FAILED: execution error at (...):
validVersion="3.0.0" does not match chart version 3.1.0

Configuring Version Locking

• Add validVersion as a top-level key in your values.yaml file and set it to the chart version you are targeting.

Example: connectware Helm chart

values.yaml

validVersion: 3.0.0

global:
  existingLicenseKeySecret: my-connectware-license

Example: connectware-agent Helm chart

values.yaml

validVersion: 3.0.0

protocolMapperAgents:
  - name: my-agent
    connectwareHost: connectware.cybus

When to Use Version Locking

Version locking is especially useful when:

• Version control: You maintain values files in Git and want to ensure they are updated together with chart upgrades.

• Multi-environment deployments: Multiple teams or environments share a common values file and you need to prevent version drift.

• GitOps workflows: Values files are applied automatically and an early failure is preferable to silent misconfiguration.