Google Git
Sign in
gerrit / plugins / multi-site / refs/heads/master
commitf80a02ec42a3813c8d3be1630c22ddf4e493e184[log] [tgz]
authorMarco Miller <marco.miller@ericsson.com>Sat May 23 16:51:28 2020 -0400
committerMarco Miller <marco.miller@ericsson.com>Sat May 23 16:51:28 2020 -0400
treebd53d5a6f1bd378c5679026118e0b1dce1b770fc
parent6f18d0f80a34785dff4869b81e3c7e5ae8112261 [diff]
parentb11026ed7ce96207a5981eb8928147fc7872506a [diff]
Merge branch 'stable-3.1'

* stable-3.1:
  CreateChangeUsingMultiGerrit: Set test access modifier
  DeleteChangeUsingMultiGerrit1: Remove extra comma

Change-Id: I0654f74eb1c49b2a27c90248ce32d5337a8552f2
tree: bd53d5a6f1bd378c5679026118e0b1dce1b770fc
  1. .bazelrc
  2. .gitignore
  3. .mailmap
  4. .settings/
  5. BUILD
  6. DESIGN.md
  7. Jenkinsfile
  8. LICENSE
  9. README.md
  10. docker-compose.kafka-broker.yaml
  11. dockerised_local_env/
  12. external_plugin_deps.bzl
  13. images/
  14. setup_local_env/
  15. src/
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.

Currently, the only mode supported is one primary read/write master and multiple read-only masters but eventually the plan is to support multiple read/write masters. The read/write master is handling any traffic while the read-only masters are serving the Gerrit GUI assets, the HTTP GET REST API and git fetch requests (git-upload-pack). The read-only masters are kept synchronized with the read/write master in order to be always ready to become a read/write master.

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 .
rm external_plugin_deps.bzl
ln -s multi-site/external_plugin_deps.bzl .

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.

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.