DOCTEAM-1985 diskless SBD (#629)

tahliar · tahliar · commit 777a65717e46 · 2026-01-16T16:02:29.000+10:00
* Test and complete diskless SBD article

jsc#DOCTEAM-1985

* Add back-up full version of SBD

* Update abstracts

* Add some conditions for diskless/diskbased
diff --git a/DC-HA-sbd-changing-configuration b/DC-HA-sbd-changing-configuration
@@ -4,7 +4,7 @@ IMG_SRC_DIR="images"
 
 ## Profiling
 PROFOS="sleha"
-PROFCONDITION="16.0"
+PROFCONDITION="16.0;sbd-diskless;sbd-diskbased"
 # Use the STRUCTID if there are several structures in one assembly file
 #STRUCTID="STRUCTURE-ID"
 #PROFARCH="x86_64;zseries;power;aarch64"
diff --git a/DC-HA-sbd-configuring-diskless b/DC-HA-sbd-configuring-diskless
@@ -0,0 +1,15 @@
+MAIN="ha-sbd-configuring.asm.xml"
+SRC_DIR="articles"
+IMG_SRC_DIR="images"
+
+## Profiling
+PROFOS="sleha"
+PROFCONDITION="16.0;sbd-diskless"
+# Use the STRUCTID if there are several structures in one assembly file
+STRUCTID="ha-sbd-configuring-diskless"
+#PROFARCH="x86_64;zseries;power;aarch64"
+
+DOCBOOK5_RNG_URI="urn:x-suse:rng:v2:geekodoc-flat"
+
+STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
+FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"
diff --git a/articles/ha-fencing-configuring.asm.xml b/articles/ha-fencing-configuring.asm.xml
@@ -65,7 +65,7 @@
         <productname version="16.0" os="sleha">&productname;</productname>
       </meta>
       <meta name="title" its:translate="yes">Configuring Node Fencing in a &ha; Cluster</meta>
-      <meta name="description" its:translate="yes">How to add physical fencing devices to manage node fencing in a &sleha; cluster</meta>
+      <meta name="description" its:translate="yes">How to add physical fencing devices to manage node fencing in a &ha; cluster</meta>
       <meta name="social-descr" its:translate="yes">Add physical fencing devices to manage HA node fencing</meta>
       <meta name="category" its:translate="no">
         <phrase>Initial Configuration</phrase>
@@ -94,7 +94,7 @@
           <term>WHAT?</term>
           <listitem>
             <para>
-              How to configure a &sleha; cluster to use a physical node fencing device.
+              Node fencing protects the cluster from data corruption by resetting failed nodes.
             </para>
           </listitem>
         </varlistentry>
@@ -120,7 +120,9 @@
           <term>GOAL</term>
             <listitem>
               <para>
-                Protect the cluster from data corruption by fencing failed nodes.
+                Configure a &ha; cluster to use a physical node fencing device. Physical
+                fencing devices can only be added after the cluster is already installed
+                and running, not during the initial cluster setup.
               </para>
             </listitem>
         </varlistentry>
@@ -143,10 +145,23 @@
           </varlistentry>
         </variablelist>
         <para>
-          To use &sbd; as the node fencing mechanism instead of a physical device, see
-          <link xlink:href="https://documentation.suse.com/sle-ha/16.0/html/HA-sbd-configuring-diskbased/">
-          <citetitle>Configuring Disk-Based &sbd; in an Existing &ha; Cluster</citetitle></link>.
+          To use &sbd; as the node fencing mechanism instead of a physical device, see one of the
+          following articles:
         </para>
+        <itemizedlist>
+          <listitem>
+            <para>
+              <link xlink:href="https://documentation.suse.com/sle-ha/16.0/html/HA-sbd-configuring-diskbased/">
+              <citetitle>Configuring Disk-Based &sbd; in an Existing &ha; Cluster</citetitle></link>
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <link xlink:href="https://documentation.suse.com/sle-ha/16.0/html/HA-sbd-configuring-diskless/">
+              <citetitle>Configuring Diskless &sbd; in an Existing &ha; Cluster</citetitle></link>
+            </para>
+          </listitem>
+        </itemizedlist>
       </abstract>
     </merge>
     <module resourceref="_ha-fencing-what-is" renderas="section"/>
diff --git a/articles/ha-qdevice-configuring.asm.xml b/articles/ha-qdevice-configuring.asm.xml
@@ -97,18 +97,18 @@
           <term>WHAT?</term>
           <listitem>
             <para>
-              How to use the &crmshell; to configure &qdevice; and &qnet; in a &ha; cluster that is
-              already installed and running.
+              &qdevice; and the arbitrator &qnet; help the cluster make quorum calculations in a
+              split-brain scenario. This allows the cluster to sustain more node failures than
+              the standard quorum rules allow.
             </para>
           </listitem>
         </varlistentry>
         <varlistentry>
           <term>WHY?</term>
           <listitem>
             <para>
-              &qdevice; and the arbitrator &qnet; participate in quorum calculations in a
-              split-brain scenario. This allows the cluster to sustain more node failures than
-              the standard quorum rules allow.
+              We recommend using &qdevice; and &qnet; in clusters with an even number of nodes,
+              especially two-node clusters.
             </para>
           </listitem>
         </varlistentry>
@@ -125,8 +125,9 @@
           <term>GOAL</term>
             <listitem>
               <para>
-                Help the cluster make quorum calculations more easily. This is recommended for
-                clusters with an even number of nodes, especially two-node clusters.
+                &qdevice; and &qnet; can be configured during the initial cluster setup or later in
+                a running cluster. This article explains how to configure them in a &ha; cluster
+                that is already installed and running.
               </para>
             </listitem>
         </varlistentry>
diff --git a/articles/ha-sbd-configuring.asm.xml b/articles/ha-sbd-configuring.asm.xml
@@ -45,6 +45,7 @@
       <description>GNU Free Documentation License</description>
     </resource>
   </resources>
+
   <!-- S T R U C T U R E S -->
   <structure renderas="article" xml:id="ha-sbd-configuring-diskbased" xml:lang="en">
     <merge>
@@ -94,8 +95,8 @@
             <term>WHAT?</term>
             <listitem>
               <para>
-                How to use the &crmshell; to configure disk-based &sbd; in a &ha; cluster that is
-                already installed and running.
+                &sbd; provides a node fencing mechanism without using an external power-off device.
+                Node fencing protects the cluster from data corruption by resetting failed nodes.
               </para>
             </listitem>
           </varlistentry>
@@ -104,8 +105,7 @@
             <listitem>
               <para>
                 To be supported, all &sleha; clusters <emphasis>must</emphasis> have node fencing
-                configured. &sbd; provides a node fencing mechanism without using an external
-                power-off device.
+                configured.
               </para>
             </listitem>
           </varlistentry>
@@ -122,7 +122,9 @@
             <term>GOAL</term>
               <listitem>
                 <para>
-                  Protect the cluster from data corruption by fencing failed nodes.
+                  &sbd; can be configured during the initial cluster setup or later in a running
+                  cluster. This article explains how to configure &sbd; in a &ha; cluster that is
+                  already installed and running.
                 </para>
               </listitem>
           </varlistentry>
@@ -149,6 +151,11 @@
             </listitem>
           </varlistentry>
         </variablelist>
+        <para>
+          To configure diskless &sbd; instead, see
+          <link xlink:href="https://documentation.suse.com/sle-ha/16.0/html/HA-sbd-configuring-diskless/">
+          <citetitle>Configuring Diskless &sbd; in an Existing &ha; Cluster</citetitle></link>.
+        </para>
         <para>
           If the &sbd; service is already running, see
           <link xlink:href="https://documentation.suse.com/sle-ha/16.0/html/HA-sbd-changing-configuration/">
@@ -190,12 +197,11 @@
     <module resourceref="_ha-glossary" renderas="glossary"/>
   </structure>
 
-  <!-- On hold until https://bugzilla.suse.com/show_bug.cgi?id=1248874 is fixed in HA 16
-<structure renderas="article" xml:id="ha-sbd-configuring-diskless" xml:lang="en">
+  <structure renderas="article" xml:id="ha-sbd-configuring-diskless" xml:lang="en">
     <merge>
       <title>Configuring Diskless &sbd; in an Existing &ha; Cluster</title>
       <revhistory xml:id="rh-ha-sbd-configuring-diskless">
-        <revision><date>2025-11-04</date>
+        <revision><date>2026-01-15</date>
           <revdescription>
             <para>
               Initial version
@@ -210,7 +216,7 @@
         <phrase>&zseries;</phrase>
       </meta>
       <meta name="productname" its:translate="no">
-        <productname version="16.0">&sleha;</productname>
+        <productname version="16.0" os="sleha">&productname;</productname>
       </meta>
       <meta name="title" its:translate="yes">Configuring Diskless &sbd; in an Existing HA Cluster</meta>
       <meta name="description" its:translate="yes">How to configure diskless &sbd; in a &ha; cluster that is already installed and running</meta>
@@ -227,7 +233,7 @@
           <dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
           <dm:component>Documentation</dm:component>
           <dm:product>
-            <dm:product condition="16.0">SUSE Linux Enterprise High Availability 16.0</dm:product>
+            <dm:product>SUSE Linux Enterprise High Availability 16.0</dm:product>
           </dm:product>
           <dm:assignee>tahlia.richardson@suse.com</dm:assignee>
        </dm:bugtracker>
@@ -239,18 +245,17 @@
             <term>WHAT?</term>
             <listitem>
               <para>
-                How to use the &crmshell; to configure diskless &sbd; in a &ha; cluster that is
-                already installed and running.
+                &sbd; provides a node fencing mechanism without using an external power-off device.
+                Node fencing protects the cluster from data corruption by resetting failed nodes.
               </para>
             </listitem>
           </varlistentry>
           <varlistentry>
             <term>WHY?</term>
             <listitem>
               <para>
-                To be supported, all &sleha; clusters <emphasis>must</emphasis> have &stonith;
-                (node fencing) configured. &sbd; provides a node fencing mechanism without using
-                an external power-off device.
+                To be supported, all &sleha; clusters <emphasis>must</emphasis> have node fencing
+                configured.
               </para>
             </listitem>
           </varlistentry>
@@ -267,7 +272,9 @@
             <term>GOAL</term>
               <listitem>
                 <para>
-                  Protect the cluster from data corruption by fencing failed nodes.
+                  &sbd; can be configured during the initial cluster setup or later in a running
+                  cluster. This article explains how to configure &sbd; in a &ha; cluster that is
+                  already installed and running.
                 </para>
               </listitem>
           </varlistentry>
@@ -289,9 +296,15 @@
             </listitem>
           </varlistentry>
         </variablelist>
+        <para>
+          To configure disk-based &sbd; instead, see
+          <link xlink:href="https://documentation.suse.com/sle-ha/16.0/html/HA-sbd-configuring-diskbased/">
+          <citetitle>Configuring Disk-Based &sbd; in an Existing &ha; Cluster</citetitle></link>.
+        </para>
         <para>
           If the &sbd; service is already running, see
-          <citetitle>Changing &sbd; Configuration</citetitle> instead. <!Add link when available>
+          <link xlink:href="https://documentation.suse.com/sle-ha/16.0/html/HA-sbd-changing-configuration/">
+          <citetitle>Changing the Configuration of &sbd;</citetitle></link>.
         </para>
       </abstract>
     </merge>
@@ -306,8 +319,8 @@
           <para>
             The <command>crm cluster crash_test</command> command simulates cluster failures and
             reports the results. To test &sbd; and node fencing, you can run one or more of the
-            tests <option>-fence-node</option>, <option>-kill-sbd</option> and
-            <option>-split-brain-iptables</option>.
+            tests <option>--fence-node</option>, <option>--kill-sbd</option> and
+            <option>--split-brain-iptables</option>.
           </para>
         </abstract>
       </merge>
@@ -317,5 +330,5 @@
       <output renderas="appendix"/>
     </module>
     <module resourceref="_ha-glossary" renderas="glossary"/>
-  </structure> -->
+  </structure>
 </assembly>
diff --git a/concepts/ha-sbd-what-is.xml b/concepts/ha-sbd-what-is.xml
@@ -19,19 +19,19 @@
     <meta name="maintainer" content="tahlia.richardson@suse.com" its:translate="no"/>
     <abstract>
       <para>
-        &sbd; (&sbd.long;) provides a node fencing mechanism without using an external power-off
-        device. The software component (the &sbd; daemon) works together with a watchdog device to
-        ensure that misbehaving nodes are fenced. &sbd; can be used in disk-based mode with shared
-        block storage, or in diskless mode using only the watchdog.
+        &sbd; (&sbd.long; or Storage-Based Death) provides a node fencing mechanism without using
+        an external power-off device. The software component (the &sbd; daemon) works together with
+        a watchdog device to ensure that misbehaving nodes are fenced. &sbd; can be used in
+        disk-based mode with shared block storage, or in diskless mode using only the watchdog.
       </para>
-      <para>
+      <para condition="sbd-diskbased">
         Disk-based &sbd; uses shared block storage to exchange fencing messages between the nodes.
         It can be used with one to three devices. One device is appropriate for simple cluster setups,
         but two or three devices are recommended for more complex setups or critical workloads.
       </para>
-      <para>
-        Diskless &sbd; fences nodes by using only the watchdog, without relying on a shared storage
-        device. A node is fenced if it loses quorum, if any monitored daemon is lost and cannot be
+      <para condition="sbd-diskless">
+        Diskless &sbd; fences nodes by using only the watchdog, without a shared storage device.
+        A node is fenced if it loses quorum, if any monitored daemon is lost and cannot be
         recovered, or if &pace; determines that the node requires fencing.
       </para>
     </abstract>
@@ -49,7 +49,7 @@
           </para>
         </listitem>
       </varlistentry>
-      <varlistentry>
+      <varlistentry condition="sbd-diskbased">
         <term>&sbd; device (disk-based &sbd;)</term>
         <listitem>
           <para>
@@ -58,7 +58,7 @@
           </para>
         </listitem>
       </varlistentry>
-      <varlistentry>
+      <varlistentry condition="sbd-diskbased">
         <term>Messages (disk-based &sbd;)</term>
         <listitem>
           <para>
@@ -80,7 +80,7 @@
   <section xml:id="ha-sbd-limitations-recommendations">
     <title>Limitations and recommendations</title>
     <variablelist>
-      <varlistentry>
+      <varlistentry condition="sbd-diskbased">
         <term>Disk-based &sbd;</term>
         <listitem>
           <itemizedlist>
@@ -121,7 +121,7 @@
           </itemizedlist>
         </listitem>
       </varlistentry>
-      <varlistentry>
+      <varlistentry condition="sbd-diskless">
         <term>Diskless &sbd;</term>
         <listitem>
           <itemizedlist>
diff --git a/snippets/ha-cluster-restart-warning.xml b/snippets/ha-cluster-restart-warning.xml
@@ -10,7 +10,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude"
 xmlns:xlink="http://www.w3.org/1999/xlink">
   <title>Cluster restart required</title>
   <para>
-    In this procedure, the script checks whether it is safe to restart the cluster services
+    In this procedure, the setup script checks whether it is safe to restart the cluster services
     automatically. If any non-<literal>stonith</literal> resources are running, the script warns
     you to restart the cluster services manually. This allows you to put the cluster into
     maintenance mode first to avoid resource downtime. However, be aware that the resources will
diff --git a/tasks/ha-sbd-setting-up-diskbased.xml b/tasks/ha-sbd-setting-up-diskbased.xml
@@ -48,7 +48,7 @@
     </listitem>
     <listitem>
       <para>
-        The &sbd; service is not running.
+        &sbd; is not configured yet.
       </para>
     </listitem>
     <listitem>
diff --git a/tasks/ha-sbd-setting-up-diskless.xml b/tasks/ha-sbd-setting-up-diskless.xml
