The @PLUGIN@ plugin must be installed on all the instances and the following fields should be specified in $site_path/etc/@PLUGIN@.config
file:
[autoReindex] enabled = false [peerInfo] strategy = static [peerInfo "static"] url = first_target_instance_url url = second_target_instance_url [http] enabled = true user = username password = password [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"] enabled = true [kafka "subscriber"] enabled = true pollingIntervalMs = 1000 autoCommitIntervalMs = 1000
autoReindex.enabled
: Enable the tracking of the latest change indexed under data/multi-site for each of the indexes. At startup scans all the changes, accounts and groups and reindex the ones that have been updated by other nodes while the server was down. When not specified, the default is “false”, that means no automatic tracking and indexing at start.
autoReindex.delay
: When autoReindex is enabled, indicates the delay aftere the plugin startup, before triggering the conditional reindexing of all changes, accounts and groups. Delay is expressed in Gerrit time values: * s, sec, second, seconds * m, min, minute, minutes * h, hr, hour, hours * d, day, days * w, week, weeks (1 week
is treated as 7 days
) * mon, month, months (1 month
is treated as 30 days
) * y, year, years (1 year
is treated as 365 days
) If a time unit suffix is not specified, hours
is assumed. Defaults to 24 hours.
When not specified, the default is "10 seconds".
autoReindex.pollInterval
: When autoReindex is enabled, indicates the interval between the conditional reindexing of all changes, accounts and groups. Delay is expressed in Gerrit time values as in autoReindex.delay. When not specified, polling of conditional reindexing is disabled.
autoReindex.interval
: Enable the tracking of the latest change indexed under data/multi-site for each of the indexes. At startup scans all the changes, accounts and groups and reindex the ones that have been updated by other nodes while the server was down. When not specified, the default is “false”, that means no automatic tracking and indexing at start.
peerInfo.strategy
: Strategy to find other peers. The only supported strategy is static
. Defaults to static
.
static
strategy allows to staticly configure the peer gerrit instance using the configuration parameter peerInfo.static.url
.peerInfo.static.url
: Specify the URL for the peer instance. If more than one peer instance is to be configured, add as many url entries as necessary.
http.user
: Username to connect to the peer instance.
http.password
: Password to connect to the peer instance.
@PLUGIN@ plugin uses REST API calls to keep the target instance in-sync. It is possible to customize the parameters of the underlying http client doing these calls by specifying the following fields:
http.connectionTimeout
: Maximum interval of time in milliseconds the plugin waits for a connection to the target instance. When not specified, the default value is set to 5000ms.
http.socketTimeout
: Maximum interval of time in milliseconds the plugin waits for a response from the target instance once the connection has been established. When not specified, the default value is set to 5000ms.
http.maxTries
: Maximum number of times the plugin should attempt when calling a REST API in the target instance. Setting this value to 0 will disable retries. When not specified, the default value is 360. After this number of failed tries, an error is logged.
http.retryInterval
: The interval of time in milliseconds between the subsequent auto-retries. When not specified, the default value is set to 10000ms.
NOTE: the default settings for http.timeout
and http.maxTries
ensure that the plugin will keep retrying to forward a message for one hour.
cache.synchronize
: Whether to synchronize cache evictions. Defaults to true.
cache.threadPoolSize
: Maximum number of threads used to send cache evictions to the target instance. Defaults to 4.
cache.pattern
: Pattern to match names of custom caches for which evictions should be forwarded (in addition to the core caches that are always forwarded). May be specified more than once to add multiple patterns. Defaults to an empty list, meaning only evictions of the core caches are forwarded.
event.synchronize
: Whether to synchronize stream events. Defaults to true.
index.numStripedLocks
: Number of striped locks to use for during secondary indexes reindex. Defaults to 10
index.synchronize
: Whether to synchronize secondary indexes. Defaults to true.
index.threadPoolSize
: Maximum number of threads used to send index events to the target instance. Defaults to 4.
index.maxTries
: Maximum number of times the plugin should attempt to reindex changes. Setting this value to 0 will disable retries. After this number of failed tries, an error is logged and the local index should be considered stale and needs to be investigated and manually reindexed. Defaults to 2.
index.retryInterval
: The interval of time in milliseconds between the subsequent auto-retries. Defaults to 30000 (30 seconds).
healthcheck.enable
: Whether to enable the health check endpoint. Defaults to ‘true’.
kafka.bootstrapServers
: List of Kafka broker hosts:port to use for publishing events to the message broker
kafka.indexEventTopic
: Name of the Kafka 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 Defaults to GERRIT.EVENT.STREAM
kafka.cacheEventTopic
: Name of the Kafka 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 Defaults to GERRIT.EVENT.PROJECT.LIST
kafka.publisher.enabled
: Enable publishing events to Kafka Defaults: false
kafka.publisher.indexEventEnabled
: Enable publication of index events Defaults: true
kafka.publisher.cacheEventEnabled
: Enable publication of cache events Defaults: true
kafka.publisher.projectListEventEnabled
: Enable publication of project list events Defaults: true
kafka.publisher.streamEventEnabled
: Enable publication of stream events Defaults: true
kafka.subscriber.enabled
: Enable consuming of Kafka events Defaults: false
kafka.subscriber.indexEventEnabled
: Enable consumption of index events Defaults: true
kafka.subscriber.cacheEventEnabled
: Enable consumption of cache events Defaults: true
kafka.subscriber.projectListEventEnabled
: Enable consumption of project list events Defaults: true
kafka.subscriber.streamEventEnabled
: Enable consumption of stream events Defaults: true
kafka.subscriber.pollingIntervalMs
: Polling interval for checking incoming events
kafka.subscriber.autoCommitIntervalMs
: Interval for committing incoming events automatically after consumption