You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by mj...@apache.org on 2020/06/02 00:21:24 UTC

[kafka] branch 2.6 updated: Kafka-10064 Add documentation for KIP-571 (#8760)

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

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


The following commit(s) were added to refs/heads/2.6 by this push:
     new 1f93906  Kafka-10064 Add documentation for KIP-571 (#8760)
1f93906 is described below

commit 1f93906eb825cfd1d4e511cea622f7067034c11e
Author: feyman2016 <fe...@aliyun.com>
AuthorDate: Tue Jun 2 08:19:26 2020 +0800

    Kafka-10064 Add documentation for KIP-571 (#8760)
    
    * Update documentation for KIP-571
    
    * update doc for KIP-571
    
    * fix comments
---
 docs/streams/developer-guide/app-reset-tool.html | 6 +++++-
 docs/streams/upgrade-guide.html                  | 4 ++++
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/docs/streams/developer-guide/app-reset-tool.html b/docs/streams/developer-guide/app-reset-tool.html
index f42235a..e875a23 100644
--- a/docs/streams/developer-guide/app-reset-tool.html
+++ b/docs/streams/developer-guide/app-reset-tool.html
@@ -56,7 +56,8 @@
         <dl class="docutils">
             <dt>Prerequisites</dt>
             <dd><ul class="first last">
-                <li><p class="first">All instances of your application must be stopped. Otherwise, the application may enter an invalid state, crash, or produce incorrect results. You can verify whether the consumer group with ID <code class="docutils literal"><span class="pre">application.id</span></code> is still active by using <code class="docutils literal"><span class="pre">bin/kafka-consumer-groups</span></code>.</p>
+                <li><p class="first">All instances of your application must be stopped. Otherwise, the application may enter an invalid state, crash, or produce incorrect results. You can verify whether the consumer group with ID <code class="docutils literal"><span class="pre">application.id</span></code> is still active by using <code class="docutils literal"><span class="pre">bin/kafka-consumer-groups</span></code>.
+                    When long session timeout has been configured, active members could take longer to get expired on the broker thus blocking the reset job to complete. Use the <code class="docutils literal"><span class="pre">--force</span></code> option could remove those left-over members immediately. Make sure to shut down all stream applications when this option is specified to avoid unexpected rebalances.</p>
                 </li>
                 <li><p class="first">Use this tool with care and double-check its parameters: If you provide wrong parameter values (e.g., typos in <code class="docutils literal"><span class="pre">application.id</span></code>) or specify parameters inconsistently (e.g., specify the wrong input topics for the application), this tool might invalidate the application&#8217;s state or even impact other applications, consumer groups, or your Kafka topics.</p>
                 </li>
@@ -117,6 +118,9 @@
                                         bootstrap.servers, as the reset tool
                                         would no longer access Zookeeper
                                         directly.
+--force                               Force removing members of the consumer group
+                                      (intended to remove left-over members if
+                                      long session timeout was configured).
 </pre></div>
             </div>
             <p>Consider the following as reset-offset scenarios for <code>input-topics</code>:</p>
diff --git a/docs/streams/upgrade-guide.html b/docs/streams/upgrade-guide.html
index 6156f98..b1af752 100644
--- a/docs/streams/upgrade-guide.html
+++ b/docs/streams/upgrade-guide.html
@@ -108,6 +108,10 @@
         enabling a user to provide <code>StateStore</code>s with alongside Processor/Transformer logic so that they are automatically
         added and connected to the processor.
     </p>
+    <p>
+        We added a <code>--force</code> option in StreamsResetter to force remove left-over members on broker side when long session time out was configured
+        as per <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-571%3A+Add+option+to+force+remove+members+in+StreamsResetter">KIP-571</a>.
+    </p>
 
     <h3><a id="streams_api_changes_250" href="#streams_api_changes_250">Streams API changes in 2.5.0</a></h3>
     <p>