Repository: kafka Updated Branches: refs/heads/0.9.0 20b09694a -> 52a3e7b27
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 <[email protected]> Reviewers: Grant Henke <[email protected]>, Ewen Cheslack-Postava <[email protected]> Closes #670 from edenhill/docs-reserved.broker.max.id (cherry picked from commit 9a0e16397e81323a3c93053ee473dfcdf3bcceb3) Signed-off-by: Ewen Cheslack-Postava <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/kafka/repo Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/52a3e7b2 Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/52a3e7b2 Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/52a3e7b2 Branch: refs/heads/0.9.0 Commit: 52a3e7b2781729fdb9f1f0767e65424f6479bb57 Parents: 20b0969 Author: Magnus Edenhill <[email protected]> Authored: Mon Dec 14 19:03:20 2015 -0800 Committer: Ewen Cheslack-Postava <[email protected]> Committed: Mon Dec 14 19:13:06 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/52a3e7b2/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 1d25959..298a7ff 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/52a3e7b2/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>
