commit | 8b7c167ffa605d00f91aa2ba8f5f17ce707cdeed | [log] [tgz] |
---|---|---|
author | Luca Milanesio <luca.milanesio@gmail.com> | Mon Oct 26 22:15:09 2020 +0000 |
committer | Luca Milanesio <luca.milanesio@gmail.com> | Wed Oct 28 22:19:55 2020 +0000 |
tree | 40fcf39d7364fffcca20b96d7b3203828541d527 | |
parent | a5a6af9a2db4fd3754f13f631d45b4aa695d015e [diff] |
Update README.md stale comment on read-only nodes Gerrit multi-site plugin supports read/write on all nodes across sites. Remove stale comment on the README.md stating that only one site could be read-write. Change-Id: I76bf4426867de6c90aef3aa33e10af0001163eb5
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:
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
This plugin is released under the same Apache 2.0 license and copyright holders as of the Gerrit Code Review project.
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.
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.