-
Notifications
You must be signed in to change notification settings - Fork 693
Add how to opt out of rollout-operator to v5 -> v6 docs #13927
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add how to opt out of rollout-operator to v5 -> v6 docs #13927
Conversation
Upgrading without this leads to a mimir deployment that can no longer be modified. Signed-off-by: Kyle Fazzari <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs look good! I left a few minor suggestions for formatting and style. We'll also want a maintainer to approve before merge. Thank you!
| Follow the [Migrate to unified proxy deployment](https://grafana.com/docs/helm-charts/mimir-distributed/v5.8.x/migration-guides/migrate-to-unified-proxy-deployment/) guide to complete this migration. | ||
|
|
||
| ### Install rollout-operator CRDs (if using rollout-operator) | ||
| ### Account for the rollout-operator |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### Account for the rollout-operator | |
| ### Account for the rollout-operator | |
| If your deployment uses the rollout-operator, you must ensure that the required CustomResourceDefinitions (CRDs) are installed. If you don’t use the rollout-operator, you must explicitly disable it in your values file to avoid unnecessary components. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
| ### Install rollout-operator CRDs (if using rollout-operator) | ||
| ### Account for the rollout-operator | ||
|
|
||
| #### If using, install CRDs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| #### If using, install CRDs | |
| #### Install CRDs when using the rollout-operator |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, although I used "if" instead of "when" given that this upgrade only happens once instead of implying some sort of ongoing thing.
| kubectl apply -f https://raw.githubusercontent.com/grafana/helm-charts/main/charts/rollout-operator/crds/zone-aware-pod-disruption-budget-custom-resource-definition.yaml | ||
| ``` | ||
|
|
||
| #### If not using, disable webhooks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| #### If not using, disable webhooks | |
| #### Disable the rollout-operator when not in use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, although I used "if" instead of "when" given that this upgrade only happens once instead of implying some sort of ongoing thing.
|
|
||
| #### If not using, disable webhooks | ||
|
|
||
| If you've opted not to use the rollout-operator, disable it in your values file: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| If you've opted not to use the rollout-operator, disable it in your values file: | |
| If you don’t use the rollout-operator, disable it in your values file to prevent the installation of related webhooks: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, although I also added the clarification that adding those webhooks without the CRDs will actually interfere with future rollouts. This really is a footgun to ship by default, by the way 😛 .
Signed-off-by: Kyle Fazzari <[email protected]>
Upgrading without this leads to a mimir deployment that can no longer be modified (e.g. #13928).
Note
Updates the 5.x→6.0 Helm chart migration guide to clarify rollout-operator handling.
rollout_operator.enabled: falseto avoid webhook interference during rolloutsWritten by Cursor Bugbot for commit 0217cbb. This will update automatically on new commits. Configure here.