@PLUGIN@ Configuration

The @PLUGIN@ plugin must be installed as a library module in the $GERRIT_SITE/lib folder of all the instances. Configuration should be specified in the $site_path/etc/@PLUGIN@.config file.

Configuration parameters

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 during reindexing of secondary indexes. 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 time interval in milliseconds between subsequent auto-retries. Defaults to 30000 (30 seconds).

broker.indexEventTopic : Name of the topic to use for publishing indexing events Defaults to GERRIT.EVENT.INDEX

broker.streamEventTopic : Name of the topic to use for publishing stream events. Note that only project events are streamed and only for global projects (see projects.pattern). Defaults to GERRIT.EVENT.STREAM

broker.gerritEventsTopic : Name of the topic to use for publishing all stream events. Default: gerrit

broker.cacheEventTopic : Name of the topic to use for publishing cache eviction events Defaults to GERRIT.EVENT.CACHE

broker.projectListEventTopic : Name of the topic to use for publishing cache eviction events Defaults to GERRIT.EVENT.PROJECT.LIST

ref-database.enabled : Enable the use of a shared ref-database Defaults: true

ref-database.enforcementRules.<policy> : Level of consistency enforcement across sites on a project:refs basis. Supports two values for enforcing the policy on multiple projects or refs. If the project or ref is omitted, apply the policy to all projects or all refs.

The <policy> can be one of the following values:

1. REQUIRED - Throw an exception if a git ref-update is processed again
a local ref not yet in sync with the shared ref-database.
The user transaction is cancelled. The Gerrit GUI (or the Git client)
receives an HTTP 500 - Internal Server Error.

2. IGNORED - Ignore any validation against the shared ref-database.

*Example:*
```
[ref-database "enforcementRules"]
   IGNORED = AProject:/refs/heads/feature
```

Ignore the alignment with the shared ref-database for AProject on refs/heads/feature.

Defaults: No rules = All projects are REQUIRED to be consistent on all refs.

projects.pattern : Specifies which projects events should be send via broker. It can be provided more than once, and supports three formats: regular expressions, wildcard matching, and single project matching. All three formats match case-sensitive.

Values starting with a caret `^` are treated as regular
expressions. For the regular expressions details please follow
official [java documentation](https://docs.oracle.com/javase/tutorial/essential/regex/).

Please note that regular expressions could also be used
with inverse match.

Values that are not regular expressions and end in `*` are
treated as wildcard matches. Wildcards match projects whose
name agrees from the beginning until the trailing `*`. So
`foo/b*` would match the projects `foo/b`, `foo/bar`, and
`foo/baz`, but neither `foobar`, nor `bar/foo/baz`.

Values that are neither regular expressions nor wildcards are
treated as single project matches. So `foo/bar` matches only
the project `foo/bar`, but no other project.

By default, all projects are matched.