Add more info about starting the init script

SUSE · Sep 3, 2024 · b126fe2 · b126fe2
1 parent ff3de2a
commit b126fe2
Showing 1 changed file with 76 additions and 15 deletions.
diff --git a/xml/ha_bootstrap_install.xml b/xml/ha_bootstrap_install.xml
@@ -154,22 +154,74 @@
       <para>
       Start the bootstrap script:
       </para>
-      <screen>&prompt.root;<command>crm cluster init</command></screen>
-      <para>Replace the <replaceable>CLUSTERNAME</replaceable>
-      placeholder with a meaningful name, like the geographical location of your
-      cluster (for example, <literal>&cluster1;</literal>).
-      This is especially helpful to create a &geo; cluster later on,
-      as it simplifies the identification of a site.
-      </para>
       <para>
-      If you need to use multicast instead of unicast (the default) for your cluster
-      communication, use the option <option>--multicast</option> (or <option>-U</option>).
+        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.
       </para>
+      <itemizedlist>
+        <listitem>
+          <para>
+            If you logged in as &rootuser;, you can run this command with no additional parameters:
+          </para>
+<screen>&prompt.root;<command>crm cluster init</command></screen>
+        </listitem>
+        <listitem>
+          <para>
+            If you logged in as a <command>sudo</command> user without SSH agent forwarding,
+            run this command with <command>sudo</command>:
+          </para>
+<screen>&prompt.user;<command>sudo crm cluster init</command></screen>
+        </listitem>
+        <listitem>
+          <para>
+            If you logged in as a <command>sudo</command> user with SSH agent forwarding enabled,
+            you must preserve the environment variable <literal>SSH_AUTH_SOCK</literal>
+            and tell the script to use your local SSH keys instead of generating keys on the node:
+          </para>
+<screen>&prompt.user;<command>sudo --preserve-env=SSH_AUTH_SOCK crm cluster init --use-ssh-agent</command></screen>
+        </listitem>
+      </itemizedlist>
       <para>
-      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 <command>crm cluster help init</command>.
       </para>
+      <variablelist>
+        <varlistentry>
+          <term>Multicast</term>
+          <listitem>
+            <para>
+              Unicast is the default transport type for cluster communication. To use multicast
+              instead, use the option <option>--multicast</option> (or <option>-U</option>).
+              For example:
+            </para>
+<screen>&prompt.root;<command>crm cluster init --multicast</command></screen>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>SBD disks</term>
+          <listitem>
+            <para>
+              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
+              <option>--sbd-device</option> (or <option>-s</option>) multiple times. For example:
+            </para>
+<screen>&prompt.root;<command>crm cluster init --sbd-device /dev/disk/by-id/<replaceable>ID1</replaceable> --sbd-device /dev/disk/by-id/<replaceable>ID2</replaceable></command></screen>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>Network interfaces</term>
+          <listitem>
+            <para>
+              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
+              <option>--interface</option> (or <option>-i</option>) twice. For example:
+            </para>
+<screen>&prompt.root;<command>crm cluster init --interface eth0 --interface eth1</command></screen>
+          </listitem>
+        </varlistentry>
+      </variablelist>
     </step>
     <step>
       <para>
@@ -206,6 +258,13 @@
       </step>
       </substeps>
     </step>
+    <step>
+      <para>
+        Enter a name for the cluster. Choose a meaningful name, like the geographical location
+        of the cluster (for example, <literal>&cluster1;</literal>). This is especially helpful
+        if you create a &geo; cluster later, as it simplifies the identification of a site.
+      </para>
+    </step>
     <step>
       <para>Configure a virtual IP address for cluster administration with &hawk2;:</para>
       <substeps>
@@ -229,9 +288,11 @@
     </step>
     </procedure>
     <para>
-    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.
     </para>
   </sect1>