You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by ew...@apache.org on 2015/12/15 04:13:01 UTC

kafka git commit: MINOR: Documentation updates for reserved.broker.max.id

Repository: kafka
Updated Branches:
  refs/heads/trunk 901fe2eec -> 9a0e16397


MINOR: Documentation updates for reserved.broker.max.id

People are facing problems upgrading their clusters with configured broker IDs above 1000 due to `reserved.broker.max.id` which wasn't very well announced.

This PR attempts to improve that somewhat by fixing the broker config docs and adding a note to the upgrade documentation.

Author: Magnus Edenhill <ma...@edenhill.se>

Reviewers: Grant Henke <gr...@gmail.com>, Ewen Cheslack-Postava <ew...@confluent.io>

Closes #670 from edenhill/docs-reserved.broker.max.id


Project: http://git-wip-us.apache.org/repos/asf/kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/9a0e1639
Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/9a0e1639
Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/9a0e1639

Branch: refs/heads/trunk
Commit: 9a0e16397e81323a3c93053ee473dfcdf3bcceb3
Parents: 901fe2e
Author: Magnus Edenhill <ma...@edenhill.se>
Authored: Mon Dec 14 19:03:20 2015 -0800
Committer: Ewen Cheslack-Postava <me...@ewencp.org>
Committed: Mon Dec 14 19:03:20 2015 -0800

----------------------------------------------------------------------
 core/src/main/scala/kafka/server/KafkaConfig.scala | 2 +-
 docs/upgrade.html                                  | 6 ++++--
 2 files changed, 5 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/9a0e1639/core/src/main/scala/kafka/server/KafkaConfig.scala
----------------------------------------------------------------------
diff --git a/core/src/main/scala/kafka/server/KafkaConfig.scala b/core/src/main/scala/kafka/server/KafkaConfig.scala
index 32dfe42..9d3150a 100755
--- a/core/src/main/scala/kafka/server/KafkaConfig.scala
+++ b/core/src/main/scala/kafka/server/KafkaConfig.scala
@@ -522,7 +522,7 @@ object KafkaConfig {
       .define(ZkEnableSecureAclsProp, BOOLEAN, Defaults.ZkEnableSecureAcls, HIGH, ZkEnableSecureAclsDoc)
 
       /** ********* General Configuration ***********/
-      .define(MaxReservedBrokerIdProp, INT, Defaults.MaxReservedBrokerId, atLeast(0), MEDIUM, MaxReservedBrokerIdProp)
+      .define(MaxReservedBrokerIdProp, INT, Defaults.MaxReservedBrokerId, atLeast(0), MEDIUM, MaxReservedBrokerIdDoc)
       .define(BrokerIdProp, INT, Defaults.BrokerId, HIGH, BrokerIdDoc)
       .define(MessageMaxBytesProp, INT, Defaults.MessageMaxBytes, atLeast(0), HIGH, MessageMaxBytesDoc)
       .define(NumNetworkThreadsProp, INT, Defaults.NumNetworkThreads, atLeast(1), HIGH, NumNetworkThreadsDoc)

http://git-wip-us.apache.org/repos/asf/kafka/blob/9a0e1639/docs/upgrade.html
----------------------------------------------------------------------
diff --git a/docs/upgrade.html b/docs/upgrade.html
index 704ec4f..63348d3 100644
--- a/docs/upgrade.html
+++ b/docs/upgrade.html
@@ -27,9 +27,11 @@
 	<li> Restart the brokers one by one for the new protocol version to take effect </li>
 </ol>
 
-Note: If you are willing to accept downtime, you can simply take all the brokers down, update the code and start all of them. They will start with the new protocol by default.
+<p><b>Note:</b> If you are willing to accept downtime, you can simply take all the brokers down, update the code and start all of them. They will start with the new protocol by default.
 
-Note: Bumping the protocol version and restarting can be done any time after the brokers were upgraded. It does not have to be immediately after.
+<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.
+
+<p><b>Note:</b> Broker IDs above 1000 are now reserved by default to automatically assigned broker IDs. If your cluster has existing broker IDs above that threshold make sure to increase the reserved.broker.max.id broker configuration property accordingly.
 
 <h5><a id="upgrade_9_breaking" href="#upgrade_9_breaking">Potential breaking changes in 0.9.0.0</a></h5>