| commit | 9f28d2f26dd9fe71be03eda8f46ee1ea508b1158 | [log] [tgz] |
|---|---|---|
| author | David Ostrovsky <david@ostrovsky.org> | Thu Jun 16 16:35:19 2022 +0200 |
| committer | David Ostrovsky <david.ostrovsky@gmail.com> | Fri Jun 17 09:17:59 2022 +0000 |
| tree | 051d140d48654e21e62b9ce00e11172ce3373ac1 | |
| parent | 9c6de9d93402eb8228c89c8cac732e8dbb686606 [diff] |
Exclude event-broker and global-refdb from shaded plugin jar multi-site plugin has only compile time dependency on event-broker and global-refdb modules. They are provided in runtime in <gerrit_site>/lib directory. That's why it should be safe to exclude them from the shaded jar. This is also done similarly to the replication plugin, that is only compile time dependency. Change-Id: I682516ff764ae9b7f24a5784adedae7af54ab647 (cherry picked from commit 5b19d94558530f152d7418c92c6c02edaccef2c8)
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.
For information about available HTTP endpoints please refer to the documentation.