Skip to content

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.

Sign up for GitHub

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

Merged
narqo merged 2 commits into from
Jan 20, 2026
Merged

Add how to opt out of rollout-operator to v5 -> v6 docs #13927

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac4fb8b
Add how to opt out of rollout-operator to v5 -> v6 docs
kyrofa Jan 6, 2026
0217cbb
Reword to suit feedback
kyrofa Jan 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion ...helm-charts/mimir-distributed/migration-guides/migrate-helm-chart-5.x-to-6.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ If your values file contains a top-level `nginx` section, you must migrate to th

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
Copy link
Contributor

@tacole02 tacole02 Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### 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.

Copy link
Contributor Author

@kyrofa kyrofa Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Contributor

@tcp13equals2 tcp13equals2 Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note on this instruction - Helm should automatically install the CRDs on a fresh install. However it will not automatically install on an upgrade - hence the manual step.

So it might be worth noting this for clarity.


#### If using, install CRDs
Copy link
Contributor

@tacole02 tacole02 Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### If using, install CRDs
#### Install CRDs when using the rollout-operator

Copy link
Contributor Author

@kyrofa kyrofa Jan 6, 2026

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 you're using the rollout-operator, install the CRDs from the rollout-operator chart:

Expand All @@ -36,6 +38,15 @@ kubectl apply -f https://raw.githubusercontent.com/grafana/helm-charts/main/char
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
Copy link
Contributor

@tacole02 tacole02 Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### If not using, disable webhooks
#### Disable the rollout-operator when not in use

Copy link
Contributor Author

@kyrofa kyrofa Jan 6, 2026

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 you've opted not to use the rollout-operator, disable it in your values file:
Copy link
Contributor

@tacole02 tacole02 Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:

Copy link
Contributor Author

@kyrofa kyrofa Jan 6, 2026

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 😛 .


```yaml
rollout_operator:
enabled: false
```

### Choose your ingest storage strategy

Choose one of the following options:
Expand Down