From b126fe22ceaaa596bb6b5838b9ee31c7f34a116d Mon Sep 17 00:00:00 2001
From: Tahlia Richardson <3069029+tahliar@users.noreply.github.com>
Date: Fri, 30 Aug 2024 17:24:15 +1000
Subject: [PATCH] Add more info about starting the init script
---
xml/ha_bootstrap_install.xml | 91 ++++++++++++++++++++++++++++++------
1 file changed, 76 insertions(+), 15 deletions(-)
diff --git a/xml/ha_bootstrap_install.xml b/xml/ha_bootstrap_install.xml
index 10e6db8ca..cc356dff6 100644
--- a/xml/ha_bootstrap_install.xml
+++ b/xml/ha_bootstrap_install.xml
@@ -154,22 +154,74 @@
Start the bootstrap script:
- &prompt.root;crm cluster init
- Replace the CLUSTERNAME
- placeholder with a meaningful name, like the geographical location of your
- cluster (for example, &cluster1;).
- This is especially helpful to create a &geo; cluster later on,
- as it simplifies the identification of a site.
-
- If you need to use multicast instead of unicast (the default) for your cluster
- communication, use the option (or ).
+ You can start the script without specifying any options. This prompts you for input for
+ some settings, as described in the next steps, and uses &crmsh;'s default values for
+ other settings.
+
+
+
+ If you logged in as &rootuser;, you can run this command with no additional parameters:
+
+&prompt.root;crm cluster init
+
+
+
+ If you logged in as a sudo user without SSH agent forwarding,
+ run this command with sudo:
+
+&prompt.user;sudo crm cluster init
+
+
+
+ If you logged in as a sudo user with SSH agent forwarding enabled,
+ you must preserve the environment variable SSH_AUTH_SOCK
+ and tell the script to use your local SSH keys instead of generating keys on the node:
+
+&prompt.user;sudo --preserve-env=SSH_AUTH_SOCK crm cluster init --use-ssh-agent
+
+
- The script checks for NTP configuration and a hardware watchdog service. If required,
- it generates the public and private SSH keys used for passwordless SSH access and
- &csync; synchronization and starts the respective services.
+ Alternatively, you can specify additional options as part of the initialization command.
+ You can include multiple options in the same command. Some examples are shown below.
+ For more options, run crm cluster help init.
+
+
+ Multicast
+
+
+ Unicast is the default transport type for cluster communication. To use multicast
+ instead, use the option (or ).
+ For example:
+
+&prompt.root;crm cluster init --multicast
+
+
+
+ SBD disks
+
+
+ In a later step, the script asks if you want to set up SBD and prompts you for a disk
+ to use. To configure the cluster with multiple SBD disks, use the option
+ (or ) multiple times. For example:
+
+&prompt.root;crm cluster init --sbd-device /dev/disk/by-id/ID1 --sbd-device /dev/disk/by-id/ID2
+
+
+
+ Network interfaces
+
+
+ In a later step, the script prompts you for a network interface for &corosync; to use.
+ To configure the cluster with two network interfaces, use the option
+ (or ) twice. For example:
+
+&prompt.root;crm cluster init --interface eth0 --interface eth1
+
+
+
@@ -206,6 +258,13 @@
+
+
+ Enter a name for the cluster. Choose a meaningful name, like the geographical location
+ of the cluster (for example, &cluster1;). This is especially helpful
+ if you create a &geo; cluster later, as it simplifies the identification of a site.
+
+ Configure a virtual IP address for cluster administration with &hawk2;:
@@ -229,9 +288,11 @@
- Finally, the script will start the cluster services to bring the
- cluster online and enable &hawk2;. The URL to use for &hawk2; is
- displayed on the screen.
+ The script checks for NTP configuration and a hardware watchdog service. If required,
+ it generates the public and private SSH keys used for passwordless SSH access and
+ &csync; synchronization and starts the respective services. Finally, the script
+ starts the cluster services to bring the cluster online and enables &hawk2;.
+ The URL to use for &hawk2; is displayed on the screen.