Remove Kafka broker configuration documentation Kafka broker code is a separate plugin, clean up multi-site documentation to reflect currently available settings. Feature: Issue 11599 Change-Id: I8e2cff4371d784933cfc330ac34008e555cba324
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md index b44d1dd..18f8d0b 100644 --- a/src/main/resources/Documentation/config.md +++ b/src/main/resources/Documentation/config.md
@@ -12,25 +12,6 @@ ## Sample configuration. ``` -[kafka] - bootstrapServers = kafka-1:9092,kafka-2:9092,kafka-3:9092 - - indexEventTopic = gerrit_index - streamEventTopic = gerrit_stream - cacheEventTopic = gerrit_cache_eviction - projectListEventTopic = gerrit_project_list - -[kafka "publisher"] - KafkaProp-compressionType = none - KafkaProp-deliveryTimeoutMs = 60000 - -[kafka "subscriber"] - pollingIntervalMs = 1000 - - KafkaProp-enableAutoCommit = true - KafkaProp-autoCommitIntervalMs = 1000 - KafkaProp-autoCommitIntervalMs = 5000 - [ref-database "zookeeper"] connectString = "localhost:2181" rootNode = "/gerrit/multi-site" @@ -93,31 +74,22 @@ : The time interval in milliseconds between subsequent auto-retries. Defaults to 30000 (30 seconds). -```kafka.bootstrapServers``` -: List of Kafka broker hosts (host:port) to use for publishing events to the message - broker - -```kafka.indexEventTopic``` -: Name of the Kafka topic to use for publishing indexing events +```broker.indexEventTopic``` +: Name of the topic to use for publishing indexing events Defaults to GERRIT.EVENT.INDEX -```kafka.streamEventTopic``` -: Name of the Kafka topic to use for publishing stream events +```broker.streamEventTopic``` +: Name of the topic to use for publishing stream events Defaults to GERRIT.EVENT.STREAM -```kafka.cacheEventTopic``` -: Name of the Kafka topic to use for publishing cache eviction events +```broker.cacheEventTopic``` +: Name of the topic to use for publishing cache eviction events Defaults to GERRIT.EVENT.CACHE -```kafka.projectListEventTopic``` -: Name of the Kafka topic to use for publishing cache eviction events +```broker.projectListEventTopic``` +: Name of the topic to use for publishing cache eviction events Defaults to GERRIT.EVENT.PROJECT.LIST -```kafka.subscriber.pollingIntervalMs``` -: Polling interval in milliseconds for checking incoming events - - Defaults: 1000 - ```ref-database.enabled``` : Enable the use of a shared ref-database Defaults: true @@ -213,24 +185,4 @@ from Zookeeper, applying the git local changes and writing the new objectId into Zookeeper - Defaults: 1000 - -#### Custom kafka properties: - -In addition to the above settings, custom Kafka properties can be explicitly set -for `publisher` and `subscriber`. -In order to be acknowledged, these properties need to be prefixed with the -`KafkaProp-` prefix and be formatted using camel case, as follows: `KafkaProp-yourPropertyValue` - -For example, if you want to set the `auto.commit.interval.ms` property for -consumers, you need to configure this property as `KafkaProp-autoCommitIntervalMs`. - -The complete list of available settings can be found directly in the kafka website: - -* **Publisher**: https://kafka.apache.org/documentation/#producerconfigs -* **Subscriber**: https://kafka.apache.org/documentation/#consumerconfigs - -#### Notes: -* From version 3.0 publisher and subscribers cannot be disabled independently anymore. -* From version 3.0 disabling the management of certain cache invalidations or re-indexing -is not available anymore. \ No newline at end of file + Defaults: 1000 \ No newline at end of file