Move HA replica site documentation from init to doc Clarify that optional init step's default in the documentation, which is to create the replica. Do not change this default behaviour, in case there are deployments already assuming it. Change-Id: I7c10d70a89dc59f758fe8bfcc4e9b452c394ece3
diff --git a/src/main/java/com/ericsson/gerrit/plugins/highavailability/Setup.java b/src/main/java/com/ericsson/gerrit/plugins/highavailability/Setup.java index 86c757e..165b0dd 100644 --- a/src/main/java/com/ericsson/gerrit/plugins/highavailability/Setup.java +++ b/src/main/java/com/ericsson/gerrit/plugins/highavailability/Setup.java
@@ -310,14 +310,6 @@ private boolean createHAReplicaSite(FileBasedConfig pluginConfig) throws ConfigInvalidException, IOException { ui.header("HA replica site setup"); - ui.message( - "It is possible to create a copy of the master site and configure both sites to run\n" - + "in HA mode as peers. This is possible when the directory where the copy will be\n" - + "created is accessible from this machine\n" - + "\n" - + "NOTE: This step is optional. If you want to create the other site manually, or\n" - + "if the other site needs to be created in a directory not accessible from this\n" - + "machine then please skip this step.\n"); if (ui.yesno(true, "Create a HA replica site")) { String replicaPath = ui.readString("ha/1", "Location of the HA replica"); Path replica = site.site_path.resolve(Paths.get(replicaPath));
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md index b2040d5..c7196c6 100644 --- a/src/main/resources/Documentation/about.md +++ b/src/main/resources/Documentation/about.md
@@ -91,5 +91,17 @@ password = password ``` +### HA replica site + +It is possible to create a copy of the master site and configure both sites to run +in HA mode as peers. This is possible when the directory where the copy will be +created is accessible from this machine. Such a replica site can be created by +means of a gerrit [site init](../../../Documentation/pgm-init.html) step, +contributed by the plugin under its init section. + +This init step is optional but defaults to creating the replica. If you want to +create the other site manually, or if the other site needs to be created in a +directory not accessible from this machine, then please skip that init step. + For further information and supported options, refer to [config](config.md) documentation.