Skip to content

Commit f0f7382

Browse files
authored
KAFKA-18422 Adjust Kafka client upgrade path section (#19119)
This patch adds a section about upgrading clients to the upgrade notes. Reviewers: Ismael Juma <[email protected]>, David Jacot <[email protected]>
1 parent d964574 commit f0f7382

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

Diff for: docs/upgrade.html

+26-7
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@
1919

2020
<script id="upgrade-template" type="text/x-handlebars-template">
2121

22-
<h4><a id="upgrade_4_1_0" href="#upgrade_4_1_0">Upgrading to 4.1.0 from any version 3.3.x through 4.0.x</a></h4>
23-
<h5><a id="upgrade_410_notable" href="#upgrade_410_notable">Notable changes in 4.1.0</a></h5>
22+
<h4><a id="upgrade_4_1_0" href="#upgrade_4_1_0">Upgrading to 4.1.0</a></h4>
23+
24+
<h5><a id="upgrade_4_1_0" href="#upgrade_4_1_0">Upgrading Servers to 4.1.0 from any version 3.3.x through 4.0.x</a></h5>
25+
<h6><a id="upgrade_410_notable" href="#upgrade_410_notable">Notable changes in 4.1.0</a></h6>
2426
<ul>
2527
<li><b>Producer</b>
2628
<ul>
@@ -29,7 +31,27 @@ <h5><a id="upgrade_410_notable" href="#upgrade_410_notable">Notable changes in 4
2931
</ul>
3032
</li>
3133
</ul>
32-
<h4><a id="upgrade_4_0_0" href="#upgrade_4_0_0">Upgrading to 4.0.0 from any version 3.3.x through 3.9.x</a></h4>
34+
35+
<h4><a id="upgrade_4_0_0" href="#upgrade_4_0_0">Upgrading to 4.0.0</a></h4>
36+
37+
<h5><a id="upgrade_clients_4_0_0" href="#upgrade_clients_4_0_0">Upgrading Clients to 4.0.0</a></h5>
38+
39+
<p><b>For a rolling upgrade:</b></p>
40+
41+
<ol>
42+
<li>Upgrade the clients one at a time: shut down the client, update the code, and restart it.</li>
43+
<li>Clients (including Streams and Connect) must be on version 2.1 or higher before upgrading to 4.0. Many deprecated APIs were removed in Kafka 4.0.
44+
For more information about the compatibility, please refer to the <a href="/{{version}}/documentation/compatibility.html">compatibility matrix</a>
45+
or <a href="https://cwiki.apache.org/confluence/x/y4kgF">KIP-1124</a>.</li>
46+
</ol>
47+
48+
<h6><a id="upgrade_clients_400_notable" href="#upgrade_clients_400_notable">Notable changes in 4.0.0</a></h6>
49+
50+
<ul>
51+
<li>Please see notable changes in the server section.</li>
52+
</ul>
53+
54+
<h5><a id="upgrade_4_0_0" href="#upgrade_4_0_0">Upgrading Servers to 4.0.0 from any version 3.3.x through 3.9.x</a></h5>
3355

3456
<p>Note: Apache Kafka 4.0 only supports KRaft mode - ZooKeeper mode has been removed. As such, <b>broker upgrades to 4.0.0 (and higher) require KRaft mode and
3557
the software and metadata versions must be at least 3.3.x</b> (the first version when KRaft mode was deemed production ready). For clusters in KRaft mode
@@ -52,12 +74,9 @@ <h4><a id="upgrade_4_0_0" href="#upgrade_4_0_0">Upgrading to 4.0.0 from any vers
5274
Every <a href="https://github.com/apache/kafka/blob/trunk/server-common/src/main/java/org/apache/kafka/server/common/MetadataVersion.java">MetadataVersion</a>
5375
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).
5476
Given your current and target versions, a downgrade is only possible if there are no metadata changes in the versions between.</li>
55-
<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.
56-
For more information, please refer to <a href="https://cwiki.apache.org/confluence/x/y4kgF">KIP-1124</a>.
57-
</li>
5877
</ol>
5978

60-
<h5><a id="upgrade_400_notable" href="#upgrade_400_notable">Notable changes in 4.0.0</a></h5>
79+
<h5><a id="upgrade_servers_400_notable" href="#upgrade_servers_400_notable">Notable changes in 4.0.0</a></h5>
6180
<ul>
6281
<li>
6382
Old protocol API versions have been removed. Users should ensure brokers are version 2.1 or higher before upgrading Java clients

0 commit comments

Comments
 (0)