Skip to content
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

docs(feature gates): updates the feature gates content #11097

Merged
merged 2 commits into from
Feb 7, 2025

Conversation

PaulRMellor
Copy link
Contributor

@PaulRMellor PaulRMellor commented Jan 30, 2025

Documentation

Updates the feature gates content.
Removes outdated and replicated content.
Consolidates the content into a single file.
For graduated features (GA), we now say refer to the docs when they were introduced for information.

Checklist

Please go through this checklist and make sure all applicable tasks have been done

  • Write tests
  • Make sure all tests pass
  • Update documentation
  • Check RBAC rights for Kubernetes / OpenShift roles
  • Try your changes from Pod inside your Kubernetes and OpenShift cluster, not just locally
  • Reference relevant issue(s) and close them after merging
  • Update CHANGELOG.md
  • Supply screenshots for visual changes, such as Grafana dashboards

@PaulRMellor PaulRMellor added this to the 0.46.0 milestone Jan 30, 2025
@PaulRMellor PaulRMellor self-assigned this Jan 30, 2025
Comment on lines 20 to 25
Check the xref:ref-operator-cluster-feature-gates-{context}[Strimzi feature gate releases].
If a feature gate is enabled, you may need to disable it before downgrading.
If the feature gate is permanently enabled, you may need to first downgrade to a version where it can still be disabled.

Kafka clusters managed by Strimzi always use node pools.
Downgrading to a cluster without node pools is not possible.
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure I would understand as a user what to look for and what to do about it to be honest. I would expect this to have a more clear information about the particular feature gates and their upgrade/downgrade limitations.

I would either remove it completely right now or leave some generic statement that sometimes, feature gates might need to be disabled when upgrading / downgrading. But that right now there is nothing special like that..

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it might be useful to reassure the user that they don't need to worry about feature gates at the moment, so I've adjusted the statement.

Copy link
Member

@scholzj scholzj left a comment

Choose a reason for hiding this comment

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

Thankd @PaulRMellor

@PaulRMellor PaulRMellor merged commit d424446 into strimzi:main Feb 7, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants