Google Git
Sign in
gerrit / plugins / multi-site / 135d416f6732f311bb620a22f79bd097247235ee
commit135d416f6732f311bb620a22f79bd097247235ee[log] [tgz]
authorLuca Milanesio <luca.milanesio@gmail.com>Sat Dec 09 00:17:05 2023 +0000
committerLuca Milanesio <luca.milanesio@gmail.com>Mon Dec 11 14:00:55 2023 +0000
treeabd605f31b61bf47ce4353681ca006c313cb2759
parenta05c1d01b97e04427121bcc37a7b2c8e6f36c69c [diff]
Do not take draft comments into account for change index up-to-date

The change index does not include draft comments.
Also, draft comments are not stored with the change notes
and are user-specific, therefore do not make sense in the
overall computation of the change latest update timestamp.

Previously, the status of the change latest ts was calculated
with the assumption that adding a draft comment would result
in the change status to be modified and therefore needed
to be reindexed up to the latest timestamp.

In multi-site the draft comments are not even replicated
because of the lack of support for draft comments stream
events, added only from Gerrit v3.9.

The consequence was the creation and indefinite retry
of the indexing events, which would have eventally clogged
the logs and the executors.

TODO: This check needs to be reintroduced after the merging to
stable-3.9, with the additional check of the draft comment stream
events being enabled or not.

Bug: Issue 40014838
Change-Id: I2f7e63bd3a97c4463fb4f5417770cbb429026c2b
1 file changed
tree: abd605f31b61bf47ce4353681ca006c313cb2759
  1. .settings/
  2. e2e-tests/
  3. images/
  4. setup_local_env/
  5. src/
  6. .bazelrc
  7. .gitignore
  8. .mailmap
  9. BUILD
  10. DESIGN.md
  11. docker-compose.kafka-broker.yaml
  12. Jenkinsfile
  13. LICENSE
  14. README.md
README.md

Gerrit multi-site plugin

This plugin allows to deploy a distributed cluster of multiple Gerrit masters each using a separate site without sharing any storage. The alignment between the masters happens using the replication plugin and an external message broker.

Requirements for the Gerrit masters are:

  • Gerrit v2.16.5 or later
  • Migrated to NoteDb
  • Connected to the same message broker
  • Accessible via a load balancer (e.g. HAProxy)

NOTE: The multi-site plugin will not start if Gerrit is not yet migrated to NoteDb.

Supports multiple read/write masters across multiple sites across different geographic locations. The Gerrit nodes are kept synchronized between each other using the replication plugin and a global ref-database in order to detect and prevent split-brains.

For more details on the overall multi-site design and roadmap, please refer to the multi-site plugin DESIGN.md document

License

This plugin is released under the same Apache 2.0 license and copyright holders as of the Gerrit Code Review project.

How to build

The multi-site plugin can only be built in tree mode, by cloning Gerrit and the multi-site plugin code, and checking them out on the desired branch.

Example of cloning Gerrit and multi-site for a stable-2.16 build:

git clone -b stable-2.16 https://gerrit.googlesource.com/gerrit
git clone -b stable-2.16 https://gerrit.googlesource.com/plugins/multi-site

cd gerrit/plugins
ln -s ../../multi-site .

Example of building the multi-site plugin:

cd gerrit
bazel build plugins/multi-site

The multi-site.jar plugin is generated to bazel-bin/plugins/multi-site/multi-site.jar.

Example of testing the multi-site plugin:

cd gerrit
bazel test plugins/multi-site:multi_site_tests

NOTE: The multi-site tests include also the use of Docker containers for instantiating and using a Kafka/Zookeeper broker. Make sure you have a Docker daemon running (/var/run/docker.sock accessible) or a DOCKER_HOST pointing to a Docker server.

Pre-requisites

Each Gerrit server of the cluster must be identified with a globally unique instance-id defined in $GERRIT_SITE/etc/gerrit.config. When migrating from a multi-site configuration with Gerrit v3.3 or earlier, you must reuse the instance-id value stored under $GERRIT_SITE/data/multi-site.

Example:

[gerrit]
  instanceId = 758fe5b7-1869-46e6-942a-3ae0ae7e3bd2

How to configure

Install the multi-site plugin into the $GERRIT_SITE/lib directory of all the Gerrit servers that are part of the multi-site cluster. Create a symbolic link from $GERRIT_SITE/lib/multi-site.jar into the $GERRIT_SITE/plugins.

Add the multi-site module to $GERRIT_SITE/etc/gerrit.config as follows:

[gerrit]
  installDbModule = com.googlesource.gerrit.plugins.multisite.GitModule
  installModule = com.googlesource.gerrit.plugins.multisite.Module

For more details on the configuration settings, please refer to the multi-site configuration documentation.

You also need to setup the Git-level replication between nodes, for more details please refer to the replication plugin documentation.

HTTP endpoints

For information about available HTTP endpoints please refer to the documentation.