Separate CRDs Helm chart for upgradeable CRD lifecycle#208
Merged
Conversation
…ions are out of sync but within 'compatible' window
Shivs11
reviewed
Feb 26, 2026
…controller into cdf/crd-chart
…controller into cdf/crd-chart
jaypipes
reviewed
Mar 9, 2026
jlegrone
approved these changes
Mar 11, 2026
…controller into cdf/crd-chart
shashwatsuri
pushed a commit
to shashwatsuri/temporal-worker-controller
that referenced
this pull request
Apr 28, 2026
## Summary - Creates a new `temporal-worker-controller-crds` Helm chart with CRDs in `templates/` (not `crds/`) so they are upgraded on `helm upgrade` - Removes `crds/` from the main chart; CRDs now live exclusively in the CRDs chart - Updates `make manifests` to output to the new chart's `templates/` - Updates `make install`, `make uninstall`, and `make deploy` to use the new paths - Adds `helm-lint-crds` and `helm-template-crds` jobs to `helm-validate.yml` CI gate - Updates `release.yml` and `helm.yml` to bump both chart versions and push both charts on release - Adds `docs/crd-management.md` with compatibility commitment, install/upgrade/rollback instructions, and a migration guide for existing users - Updates `README.md` installation section to document the two-chart install flow ## Upgrade order ``` # Install / upgrade CRDs first, then the controller helm upgrade temporal-worker-controller-crds ... helm upgrade temporal-worker-controller ... ``` ## Rollback order ``` # Roll back controller first, CRDs optionally afterward helm rollback temporal-worker-controller helm rollback temporal-worker-controller-crds # usually not needed ``` ## Migration for existing users (Controller Helm Chart v0.12.0 and earlier) Helm does not delete CRDs when upgrading to the new chart, so upgrading the main chart is safe. A one-time `helm install temporal-worker-controller-crds` adopts the existing CRDs into the new release. ## Test plan - [x] `helm lint --strict helm/temporal-worker-controller-crds` passes - [x] `helm template test-release helm/temporal-worker-controller-crds` emits two CRDs with `helm.sh/resource-policy: keep` - [x] `helm template test-release helm/temporal-worker-controller` emits zero CRDs - [x] CI `helm-validate.yml` passes all 4 jobs (lint, template, lint-crds, template-crds) 🤖 Generated with [Claude Code](https://claude.com/claude-code)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Summary
temporal-worker-controller-crdsHelm chart with CRDs intemplates/(notcrds/) so they are upgraded onhelm upgradecrds/from the main chart; CRDs now live exclusively in the CRDs chartmake manifeststo output to the new chart'stemplates/make install,make uninstall, andmake deployto use the new pathshelm-lint-crdsandhelm-template-crdsjobs tohelm-validate.ymlCI gaterelease.ymlandhelm.ymlto bump both chart versions and push both charts on releasedocs/crd-management.mdwith compatibility commitment, install/upgrade/rollback instructions, and a migration guide for existing usersREADME.mdinstallation section to document the two-chart install flowUpgrade order
Rollback order
Migration for existing users (Controller Helm Chart v0.12.0 and earlier)
Helm does not delete CRDs when upgrading to the new chart, so upgrading the main chart is safe. A one-time
helm install temporal-worker-controller-crdsadopts the existing CRDs into the new release.Test plan
helm lint --strict helm/temporal-worker-controller-crdspasseshelm template test-release helm/temporal-worker-controller-crdsemits two CRDs withhelm.sh/resource-policy: keephelm template test-release helm/temporal-worker-controlleremits zero CRDshelm-validate.ymlpasses all 4 jobs (lint, template, lint-crds, template-crds)🤖 Generated with Claude Code