Merge branch 'stable-3.0' into stable-3.1
* stable-3.0:
Rename plugin to zookeeper-refdb
Change-Id: Iea914275486566600c664cb69730e7511de13a64
diff --git a/BUILD b/BUILD
index 548e384..80c7dda 100644
--- a/BUILD
+++ b/BUILD
@@ -7,12 +7,12 @@
)
gerrit_plugin(
- name = "zookeeper",
+ name = "zookeeper-refdb",
srcs = glob(["src/main/java/**/*.java"]),
manifest_entries = [
- "Gerrit-PluginName: zookeeper",
+ "Gerrit-PluginName: zookeeper-refdb",
"Gerrit-Module: com.googlesource.gerrit.plugins.validation.dfsrefdb.zookeeper.ZkValidationModule",
- "Implementation-Title: zookeeper plugin",
+ "Implementation-Title: zookeeper ref-db plugin",
"Implementation-URL: https://review.gerrithub.io/admin/repos/GerritForge/plugins_zookeeper",
],
resources = glob(["src/main/resources/**/*"]),
@@ -26,7 +26,7 @@
)
junit_tests(
- name = "zookeeper_tests",
+ name = "zookeeper-refdb_tests",
srcs = glob(["src/test/java/**/*.java"]),
resources = glob(["src/test/resources/**/*"]),
tags = [
@@ -34,16 +34,16 @@
"zookeeper",
],
deps = [
- ":zookeeper__plugin_test_deps",
+ ":zookeeper-refdb__plugin_test_deps",
],
)
java_library(
- name = "zookeeper__plugin_test_deps",
+ name = "zookeeper-refdb__plugin_test_deps",
testonly = 1,
visibility = ["//visibility:public"],
exports = PLUGIN_DEPS + PLUGIN_TEST_DEPS + [
- ":zookeeper__plugin",
+ ":zookeeper-refdb__plugin",
"@curator-framework//jar",
"@curator-recipes//jar",
"@curator-test//jar",
diff --git a/README.md b/README.md
index f92fc18..74ba043 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,16 @@
-# plugins_zookeeper
+# Gerrit Zookeeper ref-db
-Zookeeper plugin for Gerrit Code Review
+This plugin provides an implementation of the Gerrit global ref-db backed by
+[Apache Zookeeper](https://zookeeper.apache.org/).
+
+Requirements for using this plugin are:
+
+- Gerrit v3.1 or later
+- Apache Zookeeper v3.4 or later
+
+## Typical use-case
+
+The global ref-db is a typical use-case of a Gerrit multi-master scenario
+in a multi-site setup. Refer to the
+[Gerrit multi-site plugin](https://gerrit.googlesource.com/plugins/multi-site/+/stable-3.1/DESIGN.md)
+for more details on the high level architecture.
