kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mj...@apache.org
Subject [kafka] branch 2.0 updated: MINOR: fix upgrade docs for Streams (#5394)
Date Fri, 20 Jul 2018 17:55:24 GMT
This is an automated email from the ASF dual-hosted git repository.

mjsax pushed a commit to branch 2.0
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/2.0 by this push:
     new f0d7f30   MINOR: fix upgrade docs for Streams (#5394)
f0d7f30 is described below

commit f0d7f308d4b5e270c055af21db0f6421ff3b5283
Author: Matthias J. Sax <mjsax@apache.org>
AuthorDate: Fri Jul 20 10:55:18 2018 -0700

     MINOR: fix upgrade docs for Streams (#5394)
    
    Reviewers: Guozhang Wang <guozhang@confluent.io>, Rajini Sivaram <rajini@confluent.io>
---
 docs/upgrade.html | 62 +++++++++++++++++++++++--------------------------------
 1 file changed, 26 insertions(+), 36 deletions(-)

diff --git a/docs/upgrade.html b/docs/upgrade.html
index 26e8251..00fe133 100644
--- a/docs/upgrade.html
+++ b/docs/upgrade.html
@@ -143,10 +143,10 @@
 </ul>
 
 
-<h5><a id="upgrade_200_streams" href="#upgrade_200_streams">Upgrading a 2.0.0
Kafka Streams Application</a></h5>
+<h5><a id="upgrade_200_streams_from_11" href="#upgrade_200_streams_from_11">Upgrading
a 1.1 Kafka Streams Application</a></h5>
 <ul>
-    <li> Upgrading your Streams application from 1.1.0 to 2.0.0 does not require a
broker upgrade.
-         A Kafka Streams 2.0.0 application can connect to 2.0, 1.1, 1.0, 0.11.0, 0.10.2 and
0.10.1 brokers (it is not possible to connect to 0.10.0 brokers though). </li>
+    <li> Upgrading your Streams application from 1.1 to 2.0 does not require a broker
upgrade.
+         A Kafka Streams 2.0 application can connect to 2.0, 1.1, 1.0, 0.11.0, 0.10.2 and
0.10.1 brokers (it is not possible to connect to 0.10.0 brokers though). </li>
     <li> Note that in 2.0 we have removed the public APIs that are deprecated prior
to 1.0; users leveraging on those deprecated APIs need to make code changes accordingly.
          See <a href="/{{version}}/documentation/streams/upgrade-guide#streams_api_changes_200">Streams
API changes in 2.0.0</a> for more details. </li>
 </ul>
@@ -195,14 +195,11 @@
         Hot-swapping the jar-file only might not work.</li>
 </ol>
 
-
-<!-- TODO add if 1.1.1 gets release
 <h5><a id="upgrade_111_notable" href="#upgrade_111_notable">Notable changes in
1.1.1</a></h5>
 <ul>
     <li> New Kafka Streams configuration parameter <code>upgrade.from</code>
added that allows rolling bounce upgrade from version 0.10.0.x </li>
     <li> See the <a href="/{{version}}/documentation/streams/upgrade-guide.html"><b>Kafka
Streams upgrade guide</b></a> for details about this new config.
 </ul>
--->
 
 <h5><a id="upgrade_110_notable" href="#upgrade_110_notable">Notable changes in
1.1.0</a></h5>
 <ul>
@@ -226,10 +223,10 @@
     <li> <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-227%3A+Introduce+Incremental+FetchRequests+to+Increase+Partition+Scalability">KIP-227</a>
introduced Fetch Request/Response v7.</li>
 </ul>
 
-<h5><a id="upgrade_110_streams" href="#upgrade_110_streams">Upgrading a 1.1.0
Kafka Streams Application</a></h5>
+<h5><a id="upgrade_110_streams_from_10" href="#upgrade_110_streams_from_10">Upgrading
a 1.0 Kafka Streams Application</a></h5>
 <ul>
-    <li> Upgrading your Streams application from 1.0.0 to 1.1.0 does not require a
broker upgrade.
-        A Kafka Streams 1.1.0 application can connect to 1.0, 0.11.0, 0.10.2 and 0.10.1 brokers
(it is not possible to connect to 0.10.0 brokers though). </li>
+    <li> Upgrading your Streams application from 1.0 to 1.1 does not require a broker
upgrade.
+        A Kafka Streams 1.1 application can connect to 1.0, 0.11.0, 0.10.2 and 0.10.1 brokers
(it is not possible to connect to 0.10.0 brokers though). </li>
     <li> See <a href="/{{version}}/documentation/streams/upgrade-guide#streams_api_changes_110">Streams
API changes in 1.1.0</a> for more details. </li>
 </ul>
 
@@ -278,13 +275,11 @@
         Similarly for the message format version.</li>
 </ol>
 
-<!-- TODO add if 1.0.2 gets release
 <h5><a id="upgrade_102_notable" href="#upgrade_102_notable">Notable changes in
1.0.2</a></h5>
 <ul>
     <li> New Kafka Streams configuration parameter <code>upgrade.from</code>
added that allows rolling bounce upgrade from version 0.10.0.x </li>
     <li> See the <a href="/{{version}}/documentation/streams/upgrade-guide.html"><b>Kafka
Streams upgrade guide</b></a> for details about this new config.
 </ul>
--->
 
 <h5><a id="upgrade_101_notable" href="#upgrade_101_notable">Notable changes in
1.0.1</a></h5>
 <ul>
@@ -351,7 +346,7 @@
          be used if the SaslHandshake request version is greater than 0. </li>
 </ul>
 
-<h5><a id="upgrade_100_streams" href="#upgrade_100_streams">Upgrading a 0.11.0
Kafka Streams Application</a></h5>
+<h5><a id="upgrade_100_streams_from_0110" href="#upgrade_100_streams_from_0110">Upgrading
a 0.11.0 Kafka Streams Application</a></h5>
 <ul>
     <li> Upgrading your Streams application from 0.11.0 to 1.0 does not require a broker
upgrade.
          A Kafka Streams 1.0 application can connect to 0.11.0, 0.10.2 and 0.10.1 brokers
(it is not possible to connect to 0.10.0 brokers though).
@@ -397,7 +392,6 @@
          <a href="/{{version}}/documentation/streams#streams_api_changes_0102">Streams
API changes in 0.10.2</a>, and
          <a href="/{{version}}/documentation/streams#streams_api_changes_0101">Streams
API changes in 0.10.1</a> for more details).
          Thus, you need to update and recompile your code. Just swapping the Kafka Streams
library jar file will not work and will break your application. </li>
-    <!-- TODO add if 1.0.2 gets release
     <li> Upgrading from 0.10.0.x to 1.0.2 requires two rolling bounces with config
<code>upgrade.from="0.10.0"</code> set for first upgrade phase
         (cf. <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-268%3A+Simplify+Kafka+Streams+Rebalance+Metadata+Upgrade">KIP-268</a>).
         As an alternative, an offline upgrade is also possible.
@@ -408,7 +402,6 @@
             <li> bounce each instance of your application once more to complete the
upgrade </li>
         </ul>
     </li>
-    -->
     <li> Upgrading from 0.10.0.x to 1.0.0 or 1.0.1 requires an offline upgrade (rolling
bounce upgrade is not supported)
 
         <ul>
@@ -464,7 +457,7 @@
     before you switch to 0.11.0.</li>
 </ol>
 
-<h5><a id="upgrade_1100_streams" href="#upgrade_1100_streams">Upgrading a 0.10.2
Kafka Streams Application</a></h5>
+<h5><a id="upgrade_1100_streams_from_0102" href="#upgrade_1100_streams_from_0102">Upgrading
a 0.10.2 Kafka Streams Application</a></h5>
 <ul>
     <li> Upgrading your Streams application from 0.10.2 to 0.11.0 does not require
a broker upgrade.
          A Kafka Streams 0.11.0 application can connect to 0.11.0, 0.10.2 and 0.10.1 brokers
(it is not possible to connect to 0.10.0 brokers though). </li>
@@ -491,7 +484,6 @@
          <a href="/{{version}}/documentation/streams#streams_api_changes_0102">Streams
API changes in 0.10.2</a>, and
          <a href="/{{version}}/documentation/streams#streams_api_changes_0101">Streams
API changes in 0.10.1</a> for more details).
          Thus, you need to update and recompile your code. Just swapping the Kafka Streams
library jar file will not work and will break your application. </li>
-    <!-- TODO add if 0.11.0.3 gets release
     <li> Upgrading from 0.10.0.x to 0.11.0.3 requires two rolling bounces with config
<code>upgrade.from="0.10.0"</code> set for first upgrade phase
         (cf. <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-268%3A+Simplify+Kafka+Streams+Rebalance+Metadata+Upgrade">KIP-268</a>).
         As an alternative, an offline upgrade is also possible.
@@ -502,7 +494,6 @@
             <li> bounce each instance of your application once more to complete the
upgrade </li>
         </ul>
     </li>
-    -->
     <li> Upgrading from 0.10.0.x to 0.11.0.0, 0.11.0.1, or 0.11.0.2 requires an offline
upgrade (rolling bounce upgrade is not supported)
         <ul>
             <li> stop all old (0.10.0.x) application instances </li>
@@ -512,13 +503,11 @@
     </li>
 </ul>
 
-<!-- TODO add if 0.11.0.3 gets release
 <h5><a id="upgrade_1103_notable" href="#upgrade_1103_notable">Notable changes
in 0.11.0.3</a></h5>
 <ul>
 <li> New Kafka Streams configuration parameter <code>upgrade.from</code>
added that allows rolling bounce upgrade from version 0.10.0.x </li>
 <li> See the <a href="/{{version}}/documentation/streams/upgrade-guide.html"><b>Kafka
Streams upgrade guide</b></a> for details about this new config.
 </ul>
--->
 
 <h5><a id="upgrade_1100_notable" href="#upgrade_1100_notable">Notable changes
in 0.11.0.0</a></h5>
 <ul>
@@ -660,7 +649,7 @@ Kafka cluster before upgrading your clients. Version 0.10.2 brokers support
0.8.
 
 <p><b>Note:</b> Bumping the protocol version and restarting can be done
any time after the brokers were upgraded. It does not have to be immediately after.
 
-<h5><a id="upgrade_1020_streams" href="#upgrade_1020_streams">Upgrading a 0.10.1
Kafka Streams Application</a></h5>
+<h5><a id="upgrade_1020_streams_from_0101" href="#upgrade_1020_streams_from_0101">Upgrading
a 0.10.1 Kafka Streams Application</a></h5>
 <ul>
     <li> Upgrading your Streams application from 0.10.1 to 0.10.2 does not require
a broker upgrade.
          A Kafka Streams 0.10.2 application can connect to 0.10.2 and 0.10.1 brokers (it
is not possible to connect to 0.10.0 brokers though). </li>
@@ -675,7 +664,6 @@ Kafka cluster before upgrading your clients. Version 0.10.2 brokers support
0.8.
     <li> Upgrading your Streams application from 0.10.0 to 0.10.2 does require a <a
href="#upgrade_10_1">broker upgrade</a> because a Kafka Streams 0.10.2 application
can only connect to 0.10.2 or 0.10.1 brokers. </li>
     <li> There are couple of API changes, that are not backward compatible (cf. <a
href="/{{version}}/documentation/streams#streams_api_changes_0102">Streams API changes
in 0.10.2</a> for more details).
          Thus, you need to update and recompile your code. Just swapping the Kafka Streams
library jar file will not work and will break your application. </li>
-    <!-- TODO add if 0.10.2.2 gets release
     <li> Upgrading from 0.10.0.x to 0.10.2.2 requires two rolling bounces with config
<code>upgrade.from="0.10.0"</code> set for first upgrade phase
          (cf. <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-268%3A+Simplify+Kafka+Streams+Rebalance+Metadata+Upgrade">KIP-268</a>).
          As an alternative, an offline upgrade is also possible.
@@ -686,7 +674,6 @@ Kafka cluster before upgrading your clients. Version 0.10.2 brokers support
0.8.
             <li> bounce each instance of your application once more to complete the
upgrade </li>
         </ul>
     </li>
-    -->
     <li> Upgrading from 0.10.0.x to 0.10.2.0 or 0.10.2.1 requires an offline upgrade
(rolling bounce upgrade is not supported)
         <ul>
             <li> stop all old (0.10.0.x) application instances </li>
@@ -696,12 +683,10 @@ Kafka cluster before upgrading your clients. Version 0.10.2 brokers
support 0.8.
     </li>
 </ul>
 
-<!-- TODO add if 0.10.2.2 gets release
 <h5><a id="upgrade_10202_notable" href="#upgrade_10202_notable">Notable changes
in 0.10.2.2</a></h5>
 <ul>
 <li> New configuration parameter <code>upgrade.from</code> added that allows
rolling bounce upgrade from version 0.10.0.x </li>
 </ul>
--->
 
 <h5><a id="upgrade_10201_notable" href="#upgrade_10201_notable">Notable changes
in 0.10.2.1</a></h5>
 <ul>
@@ -767,6 +752,13 @@ only support 0.10.1.x or later brokers while 0.10.1.x brokers also support
older
 
 <p><b>Note:</b> Bumping the protocol version and restarting can be done
any time after the brokers were upgraded. It does not have to be immediately after.
 
+<!-- TODO: add when 0.10.1.2 is released
+<h5><a id="upgrade_1012_notable" href="#upgrade_1012_notable">Notable changes
in 0.10.1.2</a></h5>
+<ul>
+    <li> New configuration parameter <code>upgrade.from</code> added that
allows rolling bounce upgrade from version 0.10.0.x </li>
+</ul>
+-->
+
 <h5><a id="upgrade_10_1_breaking" href="#upgrade_10_1_breaking">Potential breaking
changes in 0.10.1.0</a></h5>
 <ul>
     <li> The log retention time is no longer based on last modified time of the log
segments. Instead it will be based on the largest timestamp of the messages in a log segment.</li>
@@ -776,23 +768,21 @@ only support 0.10.1.x or later brokers while 0.10.1.x brokers also support
older
     <li> Due to the increased number of index files, on some brokers with large amount
the log segments (e.g. >15K), the log loading process during the broker startup could be
longer. Based on our experiment, setting the num.recovery.threads.per.data.dir to one may
reduce the log loading time. </li>
 </ul>
 
-<h5><a id="upgrade_1010_streams" href="#upgrade_1010_streams">Upgrading a 0.10.0
Kafka Streams Application</a></h5>
+<h5><a id="upgrade_1010_streams_from_0100" href="#upgrade_1010_streams_from_0100">Upgrading
a 0.10.0 Kafka Streams Application</a></h5>
 <ul>
     <li> Upgrading your Streams application from 0.10.0 to 0.10.1 does require a <a
href="#upgrade_10_1">broker upgrade</a> because a Kafka Streams 0.10.1 application
can only connect to 0.10.1 brokers. </li>
     <li> There are couple of API changes, that are not backward compatible (cf. <a
href="/{{version}}/documentation/streams/upgrade-guide#streams_api_changes_0101">Streams
API changes in 0.10.1</a> for more details).
-     Thus, you need to update and recompile your code. Just swapping the Kafka Streams library
jar file will not work and will break your application. </li>
-    <!-- TODO add if 0.10.1.2 gets release
-        <li> Upgrading from 0.10.0.x to 0.10.1.2 requires two rolling bounces with
config <code>upgrade.from="0.10.0"</code> set for first upgrade phase
+         Thus, you need to update and recompile your code. Just swapping the Kafka Streams
library jar file will not work and will break your application. </li>
+    <li> Upgrading from 0.10.0.x to 0.10.1.2 requires two rolling bounces with config
<code>upgrade.from="0.10.0"</code> set for first upgrade phase
          (cf. <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-268%3A+Simplify+Kafka+Streams+Rebalance+Metadata+Upgrade">KIP-268</a>).
          As an alternative, an offline upgrade is also possible.
-            <ul>
-                <li> prepare your application instances for a rolling bounce and make
sure that config <code>upgrade.from</code> is set to <code>"0.10.0"</code>
for new version 0.10.1.2 </li>
-                <li> bounce each instance of your application once </li>
-                <li> prepare your newly deployed 0.10.1.2 application instances for
a second round of rolling bounces; make sure to remove the value for config <code>upgrade.mode</code>
</li>
-                <li> bounce each instance of your application once more to complete
the upgrade </li>
-            </ul>
-        </li>
-        -->
+        <ul>
+            <li> prepare your application instances for a rolling bounce and make sure
that config <code>upgrade.from</code> is set to <code>"0.10.0"</code>
for new version 0.10.1.2 </li>
+            <li> bounce each instance of your application once </li>
+            <li> prepare your newly deployed 0.10.1.2 application instances for a second
round of rolling bounces; make sure to remove the value for config <code>upgrade.mode</code>
</li>
+            <li> bounce each instance of your application once more to complete the
upgrade </li>
+        </ul>
+    </li>
     <li> Upgrading from 0.10.0.x to 0.10.1.0 or 0.10.1.1 requires an offline upgrade
(rolling bounce upgrade is not supported)
     <ul>
         <li> stop all old (0.10.0.x) application instances </li>


Mime
View raw message