Skip to content

Commit 50009cc

Browse files
AndrewJSchofieldAndrewJSchofield
authored
KAFKA-19635: KIP-1147 changes for upgrade.html (#20415)
Updates to `docs/upgrade.html` for https://cwiki.apache.org/confluence/display/KAFKA/KIP-1147:+Improve+consistency+of+command-line+arguments. Reviewers: Apoorv Mittal <[email protected]>
1 parent 3c378da commit 50009cc

File tree

1 file changed

+69
-3
lines changed

1 file changed

+69
-3
lines changed

‎docs/upgrade.html

Lines changed: 69 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,15 @@ <h5><a id="upgrade_4_2_0_from" href="#upgrade_4_2_0_from">Upgrading Servers to 4
2525

2626
<h5><a id="upgrade_420_notable" href="#upgrade_420_notable">Notable changes in 4.2.0</a></h5>
2727
<ul>
28-
<li>The <code>org.apache.kafka.disallowed.login.modules</code> config was deprecated. Please use the <code>org.apache.kafka.allowed.login.modules</code>
28+
<li>
29+
The <code>org.apache.kafka.disallowed.login.modules</code> config was deprecated. Please use the <code>org.apache.kafka.allowed.login.modules</code>
2930
instead.
3031
</li>
3132
<li>
3233
The <code>remote.log.manager.thread.pool.size</code> config was deprecated. Please use the <code>remote.log.manager.follower.thread.pool.size</code> instead.
3334
</li>
34-
<li>The <code>KafkaPrincipalBuilder</code> now extends <code>KafkaPrincipalSerde</code>. Force developer to implement <code>KafkaPrincipalSerde</code> interface for custom <code>KafkaPrincipalBuilder</code>.
35+
<li>
36+
The <code>KafkaPrincipalBuilder</code> now extends <code>KafkaPrincipalSerde</code>. Force developer to implement <code>KafkaPrincipalSerde</code> interface for custom <code>KafkaPrincipalBuilder</code>.
3537
For further details, please refer to <a href="https://cwiki.apache.org/confluence/x/1gq9F">KIP-1157</a>.
3638
</li>
3739
<li>
@@ -41,9 +43,73 @@ <h5><a id="upgrade_420_notable" href="#upgrade_420_notable">Notable changes in 4
4143
The <code>PARTITIONER_ADPATIVE_PARTITIONING_ENABLE_CONFIG</code> in <code>ProducerConfig</code> was deprecated and will be removed in Kafka 5.0. Please use the <code>PARTITIONER_ADAPTIVE_PARTITIONING_ENABLE_CONFIG</code> instead.
4244
</li>
4345
<li>
44-
The <code>ConsumerPerformance</code> command line tool has a new <code>include</code> option that is alternative to the <code>topic</code> option.
46+
The <code>ConsumerPerformance</code> command line tool has a new <code>--include</code> option that is an alternative to the <code>--topic</code> option.
4547
This new option allows to pass a regular expression specifying a list of topics to include for consumption, which is useful to test consumer performance across multiple topics or dynamically matching topic sets.
4648
</li>
49+
<li>
50+
The consistency of argument names for the command-line tools has been improved (<a href="https://cwiki.apache.org/confluence/x/DguWF">KIP-1147</a>).
51+
The deprecated options will be removed in Kafka 5.0.
52+
<ul>
53+
<li>
54+
In <code>kafka-producer-perf-test.sh</code>, <code>--bootstrap-server</code> and <code>--reporting-interval</code> option are added.
55+
</li>
56+
<li>
57+
In <code>kafka-console-consumer.sh</code> and <code>kafka-console-share-consumer.sh</code>, the option <code>--property</code>
58+
which is used to specify the properties for the formatter is deprecated in favor of <code>--formatter-property</code>.
59+
</li>
60+
<li>
61+
In <code>kafka-consumer-perf-test.sh</code> and <code>kafka-share-consumer-perf-test.sh</code>, the option <code>--messages</code>
62+
is deprecated in favor of <code>--num-records</code> to bring all performance testing tools in line.
63+
</li>
64+
<li>
65+
The option <code>--command-property</code> is used for all command-line tools which accept configuration properties directly on
66+
the command line. The tools affected are:
67+
<ul>
68+
<li>
69+
<code>kafka-console-consumer.sh</code>, <code>kafka-console-producer.sh</code> and
70+
<code>kafka-console-share-consumer.sh</code> (<code>--consumer-property</code> and <code>--producer-property</code> are
71+
deprecated in favor of <code>--command-property</code>)
72+
</li>
73+
<li>
74+
<code>kafka-producer-perf-test.sh</code> (<code>--producer-props</code> is deprecated in favor of <code>--command-property</code>)
75+
</li>
76+
<li>
77+
<code>kafka-consumer-perf-test.sh</code> and <code>kafka-share-consumer-perf-test.sh</code> gain
78+
<code>--command-property</code> to bring all performance testing tools in line
79+
</li>
80+
</ul>
81+
</li>
82+
<li>
83+
The option <code>--command-config</code> is used for all command-line tools which accept a file of configuration properties.
84+
The tools affected are:
85+
<ul>
86+
<li>
87+
<code>kafka-cluster.sh</code> (<code>--config</code> is deprecated in favor of <code>--command-config</code>)
88+
</li>
89+
<li>
90+
<code>kafka-console-consumer.sh</code>, <code>kafka-console-producer.sh</code> and
91+
<code>kafka-console-share-consumer.sh</code> (<code>--consumer.config</code> and <code>--producer.config</code> are
92+
deprecated in favor of <code>--command-config</code>)
93+
</li>
94+
<li>
95+
<code>kafka-consumer-perf-test.sh</code>, <code>kafka-producer-perf-test.sh</code> and
96+
<code>kafka-share-consumer-perf-test.sh</code> (<code>--consumer.config</code> and
97+
<code>--producer.config</code> are deprecated in favor of <code>--command-config</code>)
98+
</li>
99+
<li>
100+
<code>kafka-verifiable-consumer.sh</code> and <code>kafka-verifiable-producer.sh</code>
101+
(<code>--consumer.config</code> and <code>--producer.config</code> are deprecated in favor of <code>--command-config</code>)
102+
</li>
103+
<li>
104+
<code>kafka-leader-election.sh</code> (<code>--admin.config</code> is deprecated in favor of <code>--command-config</code>)
105+
</li>
106+
<li>
107+
<code>kafka-streams-application-reset.sh</code> (<code>--config-file</code> is deprecated in favor of <code>--command-config</code>)
108+
</li>
109+
</ul>
110+
</li>
111+
</ul>
112+
</li>
47113
</ul>
48114

49115
<h4><a id="upgrade_4_1_0" href="#upgrade_4_1_0">Upgrading to 4.1.0</a></h4>

0 commit comments

Comments
 (0)