[kafka] branch 2.4 updated: MINOR: add UPGRADE_FROM to config docs (#7825)

[gu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

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


The following commit(s) were added to refs/heads/2.4 by this push:
     new c324dfc  MINOR: add UPGRADE_FROM to config docs (#7825)
c324dfc is described below

commit c324dfc31769b9b63df7e149c92d7f2db01fd828
Author: A. Sophie Blee-Goldman <so...@confluent.io>
AuthorDate: Thu Dec 12 18:43:37 2019 -0800

    MINOR: add UPGRADE_FROM to config docs (#7825)
    
    Reviewers: Guozhang Wang <wa...@gmail.com>
---
 docs/streams/developer-guide/config-streams.html | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/streams/developer-guide/config-streams.html b/docs/streams/developer-guide/config-streams.html
index 221e3c0..e789fa1 100644
--- a/docs/streams/developer-guide/config-streams.html
+++ b/docs/streams/developer-guide/config-streams.html
@@ -284,6 +284,11 @@
             <td colspan="2">Timestamp extractor class that implements the <code class="docutils literal"><span class="pre">TimestampExtractor</span></code> interface.</td>
             <td>See <a class="reference internal" href="#streams-developer-guide-timestamp-extractor"><span class="std std-ref">Timestamp Extractor</span></a></td>
           </tr>
+          <tr class="row-odd"><td>upgrade.from</td>
+            <td>Medium</td>
+            <td colspan="2">The version you are upgrading from during a rolling upgrade.</td>
+            <td>See <a class="reference internal" href="#streams-developer-guide-upgrade-from"><span class="std std-ref">Upgrade From</span></a></td>
+          </tr>
           <tr class="row-even"><td>value.serde</td>
             <td>Medium</td>
             <td colspan="2">Default serializer/deserializer class for record values, implements the <code class="docutils literal"><span class="pre">Serde</span></code> interface (see also key.serde).</td>
@@ -567,6 +572,17 @@
               </div>
             </div></blockquote>
         </div>
+        <div class="section" id="upgrade-from">
+          <h4><a class="toc-backref" href="#id14">upgrade.from</a><a class="headerlink" href="#upgrade-from" title="Permalink to this headline"></a></h4>
+          <blockquote>
+            <div>
+              The version you are upgrading from. It is important to set this config when performing a rolling upgrade to certain versions, as described in the upgrade guide.
+              You should set this config to the appropriate version before bouncing your instances and upgrading them to the newer version. Once everyone is on the
+              newer version, you should remove this config and do a second rolling bounce. It is only necessary to set this config and follow the two-bounce upgrade path
+              when upgrading from below version 2.0, or when upgrading to 2.4+ from any version lower than 2.4.
+            </div>
+          </blockquote>
+        </div>
       </div>
       <div class="section" id="kafka-consumers-and-producer-configuration-parameters">
         <h3><a class="toc-backref" href="#id16">Kafka consumers, producer and admin client configuration parameters</a><a class="headerlink" href="#kafka-consumers-and-producer-configuration-parameters" title="Permalink to this headline"></a></h3>