📖 [Docs] Downgrade an extension #1277
Conversation
Significantly expanded the documentation to include detailed steps on downgrading a ClusterExtension, including disabling CRD safety checks and overriding upgrade constraints. Added prerequisites, troubleshooting, and post-downgrade verification sections. Signed-off-by: Brett Tofel <[email protected]>
Signed-off-by: Brett Tofel <[email protected]>
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
fixes #1229 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1277 +/- ##
=======================================
Coverage 76.51% 76.51%
=======================================
Files 40 40
Lines 2363 2363
=======================================
Hits 1808 1808
Misses 389 389
Partials 166 166
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Signed-off-by: Brett Tofel <[email protected]>
|
|
||
| ## Introduction | ||
|
|
||
| Downgrading a `ClusterExtension` involves reverting the extension to a previous available version. This process might be required due to compatibility issues, unexpected behavior in the newer version, or specific feature requirements that are only available in an earlier release. This guide provides step-by-step instructions to safely downgrade a `ClusterExtension`, including necessary overrides to bypass default constraints and disable CRD safety checks. |
There was a problem hiding this comment.
I have a bit of an aversion to saying that this guide will help you downgrade "safely". IMO, performing a downgrade with the type of software we are managing with OLM is inherently an "unsafe" operation. While it may not always be the case, my assumption would be that a user runs the risk of data loss, invalidation of anything stored at new CRD versions, and potentially break clients that expect the newer version to be running. Before doing a downgrade, users should be confident that they want to do it and that they understand and have considered the potential consequences of performing a downgrade.
There was a problem hiding this comment.
Yeah, that's fair. I have reworded the intro entirely, incorporating your feedback. Thanks!
Enhanced downgrade guide with new risks and update steps. Replaced manual `kubectl edit` step with a `kubectl patch` command for disabling CRD safety checks. Signed-off-by: Brett Tofel <[email protected]>
4 participants
Expanded the documentation to include detailed steps on downgrading a ClusterExtension, including disabling CRD safety checks and overriding upgrade constraints. Added prerequisites, troubleshooting, and post-downgrade verification sections.
Reviewer Checklist