Move cluster setups with packaged scripts to top 78/54278/1
authorJamo Luhrsen <jluhrsen@redhat.com>
Sun, 2 Apr 2017 20:52:43 +0000 (13:52 -0700)
committerColin Dixon <colin@colindixon.com>
Mon, 3 Apr 2017 16:44:36 +0000 (16:44 +0000)
Since we seem to agree that using the cluster setup scripts are
the best or easiest or first method for setting up a cluster it
should be near the top of our clustering setup guide

Change-Id: Id8dd9c87cedf6f4b3538e42740cf112895f6d047
Signed-off-by: Jamo Luhrsen <jluhrsen@redhat.com>
(cherry picked from commit ecc32ea9433da746ff692eb70468bcc2e5837378)

docs/getting-started-guide/common-features/clustering.rst

index 944b90df642a11a964d9b55dd0f36fedbde9bb22..209b595e31d975adbc6ee910096829f75e5bcf40 100644 (file)
@@ -85,6 +85,53 @@ To implement clustering, the deployment considerations are as follows:
   that it can rejoin the cluster. Once a restarted node joins a cluster, it
   will synchronize with the lead node automatically.
 
+Clustering Scripts
+------------------
+
+OpenDaylight includes some scripts to help with the clustering configuration.
+
+.. note::
+
+    Scripts are stored in the OpenDaylight distribution/bin folder, and
+    maintained in the distribution project
+    `repository <https://git.opendaylight.org/gerrit/p/integration/distribution>`_
+    in the folder distribution-karaf/src/main/assembly/bin/.
+
+Configure Cluster Script
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+This script is used to configure the cluster parameters (e.g. akka.conf,
+module-shards.conf) on a member of the controller cluster. The user should
+restart the node to apply the changes.
+
+.. note::
+
+    The script can be used at any time, even before the controller is started
+    for the first time.
+
+Usage::
+
+    bin/configure_cluster.sh <index> <seed_nodes_list>
+
+* index: Integer within 1..N, where N is the number of seed nodes. This indicates
+  which controller node (1..N) is configured by the script.
+* seed_nodes_list: List of seed nodes (IP address), separated by comma or space.
+
+The IP address at the provided index should belong to the member executing
+the script. When running this script on multiple seed nodes, keep the
+seed_node_list the same, and vary the index from 1 through N.
+
+Optionally, shards can be configured in a more granular way by modifying the
+file "custom_shard_configs.txt" in the same folder as this tool. Please see
+that file for more details.
+
+Example::
+
+    bin/configure_cluster.sh 2 192.168.0.1 192.168.0.2 192.168.0.3
+
+The above command will configure the member 2 (IP address 192.168.0.2) of a
+cluster made of 192.168.0.1 192.168.0.2 192.168.0.3.
+
 Setting Up a Multiple Node Cluster
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -300,53 +347,6 @@ Sample ``module-shards.conf`` file::
        }
    ]
 
-Clustering Scripts
-------------------
-
-OpenDaylight includes some scripts to help with the clustering configuration.
-
-.. note::
-
-    Scripts are stored in the OpenDaylight distribution/bin folder, and
-    maintained in the distribution project
-    `repository <https://git.opendaylight.org/gerrit/p/integration/distribution>`_
-    in the folder distribution-karaf/src/main/assembly/bin/.
-
-Configure Cluster Script
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-This script is used to configure the cluster parameters (e.g. akka.conf,
-module-shards.conf) on a member of the controller cluster. The user should
-restart the node to apply the changes.
-
-.. note::
-
-    The script can be used at any time, even before the controller is started
-    for the first time.
-
-Usage::
-
-    bin/configure_cluster.sh <index> <seed_nodes_list>
-
-* index: Integer within 1..N, where N is the number of seed nodes. This indicates
-  which controller node (1..N) is configured by the script.
-* seed_nodes_list: List of seed nodes (IP address), separated by comma or space.
-
-The IP address at the provided index should belong to the member executing
-the script. When running this script on multiple seed nodes, keep the
-seed_node_list the same, and vary the index from 1 through N.
-
-Optionally, shards can be configured in a more granular way by modifying the
-file "custom_shard_configs.txt" in the same folder as this tool. Please see
-that file for more details.
-
-Example::
-
-    bin/configure_cluster.sh 2 192.168.0.1 192.168.0.2 192.168.0.3
-
-The above command will configure the member 2 (IP address 192.168.0.2) of a
-cluster made of 192.168.0.1 192.168.0.2 192.168.0.3.
-
 Set Persistence Script
 ^^^^^^^^^^^^^^^^^^^^^^