Repository navigation
Use 2 chart for upgrading the crds using helm - #234
Conversation
alicefr
changed the title
|
@Mergifyio backport release-0.2 |
✅ Backports have been createdDetails
|
|
|
||
| ## Upgrade | ||
|
|
||
| Upgrade both charts. The CRD chart must be upgraded first: |
There was a problem hiding this comment.
We might want to declare that the CRD chart is a required dependency of the operator chart so that the ordering will be preserved and make the installation / upgrade process less error-prone: https://helm.sh/docs/helm/helm_dependency/.
There was a problem hiding this comment.
Now it does use the crds chart as dependency. Thanks for the suggestion!
CRDs are shipped in a separate sub-chart (bootc-operator-crds) and declared as a Helm dependency of the operator chart. This keeps CRDs in templates/ so helm upgrade can update them, while preserving install/upgrade ordering automatically. The dependency is conditional on crds.install (default true), allowing users who manage CRDs separately to disable it. Assisted-by: AI Signed-off-by: Alice Frosi <afrosi@redhat.com>
Publish the CRD chart to the OCI registry before the operator chart. Run helm dependency build for the operator so the CRD sub-chart is bundled into the package. Sync the dependency version at release time. Assisted-by: AI Signed-off-by: Alice Frosi <afrosi@redhat.com>
Document single-chart install and upgrade using the CRD dependency. Include instructions for managing CRDs separately with crds.install=false. Assisted-by: AI Signed-off-by: Alice Frosi <afrosi@redhat.com>
Assisted-by: AI Signed-off-by: Alice Frosi <afrosi@redhat.com>
d2c698d to
3fe0fc9
Compare
|
Tested created (and deleted already) a draft release for 0.2.1 and the installation works as expected |
| > **Warning**: uninstalling the chart also removes the CRDs and all | ||
| > their instances cluster-wide. | ||
|
|
There was a problem hiding this comment.
could we have this documented for roll back as well, same will happen for that when we change crd.install from true to false to previous chart without running helm unistall?
There was a problem hiding this comment.
Not every project support rollbacks. In fact, it might be disruptive if we add new required fields to the api and to rollback to the previous version. Can we leave rollback out of scope?
3 participants
Helm doesn't upgrade or delete the crds (see the official documentation),. In the official documentation, one of the method to solve this is to create a separte chart for the crds, in this way the can be installed and upgrade using helm. In particular, we are interested in the fact that the crds are released as oci artifact.
Additionally, the documentation now also covers the upgrade and uninstall paths