This is an automated email from the ASF dual-hosted git repository.
ableegoldman pushed a commit to branch 3.0
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/3.0 by this push:
new 401e008 MINOR: update doc for default assignor change (#11009)
401e008 is described below
commit 401e008dfe932921fc51944cb3bded73683cb215
Author: Luke Chen <[email protected]>
AuthorDate: Wed Jul 14 04:00:15 2021 +0800
MINOR: update doc for default assignor change (#11009)
Update the doc and upgrade doc for default assignor change. REF: #10903
Reviewers: Anna Sophie Blee-Goldman <[email protected]>
---
.../main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java | 6 ++++--
docs/upgrade.html | 3 +++
2 files changed, 7 insertions(+), 2 deletions(-)
diff --git
a/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java
b/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java
index b48a37e..783c97e 100644
---
a/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java
+++
b/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java
@@ -114,15 +114,17 @@ public class ConsumerConfig extends AbstractConfig {
"ordered by preference, of supported partition assignment strategies
that the client will use to distribute " +
"partition ownership amongst consumer instances when group management
is used. Available options are:" +
"<ul>" +
- "<li><code>org.apache.kafka.clients.consumer.RangeAssignor</code>: The
default assignor, which works on a per-topic basis.</li>" +
+ "<li><code>org.apache.kafka.clients.consumer.RangeAssignor</code>:
Assigns partitions on a per-topic basis.</li>" +
"<li><code>org.apache.kafka.clients.consumer.RoundRobinAssignor</code>: Assigns
partitions to consumers in a round-robin fashion.</li>" +
"<li><code>org.apache.kafka.clients.consumer.StickyAssignor</code>:
Guarantees an assignment that is " +
"maximally balanced while preserving as many existing partition
assignments as possible.</li>" +
"<li><code>org.apache.kafka.clients.consumer.CooperativeStickyAssignor</code>:
Follows the same StickyAssignor " +
"logic, but allows for cooperative rebalancing.</li>" +
"</ul>" +
+ "<p>The default assignor is [RangeAssignor,
CooperativeStickyAssignor], which will use the RangeAssignor by default, " +
+ "but allows upgrading to the CooperativeStickyAssignor with just a
single rolling bounce that removes the RangeAssignor from the list.</p>" +
"<p>Implementing the
<code>org.apache.kafka.clients.consumer.ConsumerPartitionAssignor</code> " +
- "interface allows you to plug in a custom assignment strategy.";
+ "interface allows you to plug in a custom assignment strategy.</p>";
/**
* <code>auto.offset.reset</code>
diff --git a/docs/upgrade.html b/docs/upgrade.html
index c0d8eab..60955cd 100644
--- a/docs/upgrade.html
+++ b/docs/upgrade.html
@@ -62,6 +62,9 @@
were removed. These methods were not intended to be public API and
there is no replacement.</li>
<li>The <code>NoOffsetForPartitionException.partition()</code> method
was removed. Please use <code>partitions()</code>
instead.</li>
+ <li>The default <code>partition.assignment.strategy</code> is changed
to "[RangeAssignor, CooperativeStickyAssignor]",
+ which will use the RangeAssignor by default, but allows upgrading
to the CooperativeStickyAssignor with just a single rolling bounce that removes
the RangeAssignor from the list.
+ Please check the client upgrade path guide <a
href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-429:+Kafka+Consumer+Incremental+Rebalance+Protocol#KIP429:KafkaConsumerIncrementalRebalanceProtocol-Consumer";>here</a>
for more detail.</li>
<li>The Scala <code>kafka.common.MessageFormatter</code> was removed.
Please use the Java <code>org.apache.kafka.common.MessageFormatter</code>.</li>
<li>The <code>MessageFormatter.init(Properties)</code> method was
removed. Please use <code>configure(Map)</code> instead.</li>
<li>The <code>checksum()</code> method has been removed from
<code>ConsumerRecord</code> and <code>RecordMetadata</code>. The message
