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

KAFKA-18422: add Kafka client upgrade path #19097

Merged
merged 3 commits into from
Mar 4, 2025

Conversation

brandboat
Copy link
Member

@brandboat brandboat commented Mar 4, 2025

Add client upgrade documentation, for more information, please refer to https://cwiki.apache.org/confluence/x/y4kgF

@github-actions github-actions bot added docs small Small PRs labels Mar 4, 2025
@brandboat
Copy link
Member Author

Preview:
image

As the discussion on KIP-1124 is still ongoing and the content is quite extensive with many details, it may not be ideal to include everything in the documentation. Instead, we can add a KIP link to the doc. By the way, I'm unsure if the current location of the documentation is appropriate. Let me know if you have any suggestions. Thank you!

Copy link
Contributor

@frankvicky frankvicky left a comment

Choose a reason for hiding this comment

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

Not sure if KIP-1124 should also be linked in zk2kraft.html.
WDYT?

@brandboat
Copy link
Member Author

Not sure if KIP-1124 should also be linked in zk2kraft.html.
WDYT?

Thanks for the comment @frankvicky. Perhaps not? zk2kraft.html focuses on ZK migration to KRaft, which seems more related to the server side. In contrast, KIP-1124 focuses on the client upgrade.
If you're referring to client-server compatibility, there's an existing PR addressing that: #18091.

@@ -46,6 +46,9 @@ <h4><a id="upgrade_4_0_0" href="#upgrade_4_0_0">Upgrading to 4.0.0 from any vers
Every <a href="https://github.com/apache/kafka/blob/trunk/server-common/src/main/java/org/apache/kafka/server/common/MetadataVersion.java">MetadataVersion</a>
has a boolean parameter that indicates if there are metadata changes (i.e. <code>IBP_4_0_IV1(23, "4.0", "IV1", true)</code> means this version has metadata changes).
Given your current and target versions, a downgrade is only possible if there are no metadata changes in the versions between.</li>
<li>For the Kafka client upgrade path, note that many deprecated APIs were removed in Kafka 4.0. Additionally, upgrading directly to 4.x from certain versions is not feasible.
For more information, please refer to <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-1124%3A+Providing+a+clear+Kafka+Client+upgrade+path+for+4.x">KIP-1124</a>.
Copy link
Member

Choose a reason for hiding this comment

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

Could you please use https://cwiki.apache.org/confluence/x/y4kgF instead? otherwise, the link gets invalid after renaming.

@chia7712
Copy link
Member

chia7712 commented Mar 4, 2025

I'm going to merge this PR for 4.0 RC1, and we will keep tweaking the docs

@chia7712 chia7712 merged commit be9c4a4 into apache:trunk Mar 4, 2025
14 of 15 checks passed
chia7712 pushed a commit that referenced this pull request Mar 4, 2025
Add client upgrade documentation, for more information, please refer to https://cwiki.apache.org/confluence/x/y4kgF

Reviewers: TengYao Chi <[email protected]>, Chia-Ping Tsai <[email protected]>
@chia7712
Copy link
Member

chia7712 commented Mar 4, 2025

cherry-pick to 4.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs small Small PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants