Merge pull request #111650 from lcavalle/TELCODOCS-2706-dita-cleanup

TELCODOCS-2706 DITA migration cleanup for update-before-the-update.adoc

Author: slovern

modules/creating-single-etcd-backup.adoc

@@ -7,6 +7,7 @@
 [id="creating-single-etcd-backup_{context}"]
 = Creating a single automated etcd backup
 
+[role="_abstract"]
 Follow these steps to create a single etcd backup by creating and applying a custom resource (CR).
 
 .Prerequisites
@@ -32,10 +33,11 @@ spec:
     - ReadWriteOnce
   resources:
     requests:
-      storage: 200Gi <1>
+      storage: 200Gi
   volumeMode: Filesystem
 ----
-<1> The amount of storage available to the PVC. Adjust this value for your requirements.
++
+Adjust the `storage` value for your requirements.
 +
 .. Apply the PVC by running the following command:
 +
@@ -73,9 +75,10 @@ metadata:
   name: etcd-single-backup
   namespace: openshift-etcd
 spec:
-  pvcName: etcd-backup-pvc <1>
+  pvcName: etcd-backup-pvc
 ----
-<1> The name of the PVC to save the backup to. Adjust this value according to your environment.
++
+Adjust the `pvcName` value according to your environment.
 +
 .. Apply the CR to start a single backup:
 +
@@ -115,7 +118,7 @@ metadata:
   name: etcd-backup-pv-fs
 spec:
   capacity:
-    storage: 100Gi <1>
+    storage: 100Gi
   volumeMode: Filesystem
   accessModes:
   - ReadWriteOnce
@@ -130,10 +133,15 @@ spec:
       - key: kubernetes.io/hostname
          operator: In
          values:
-         - <example_master_node> <2>
+         - <example_master_node>
 ----
-<1> The amount of storage available to the PV. Adjust this value for your requirements.
-<2> Replace this value with the node to attach this PV to.
++
+where:
++
+--
+`100Gi`:: Specifies the amount of storage available to the PV. Adjust this value for your requirements.
+`<example_master_node>`:: Specifies the node to attach this PV to.
+--
 +
 .. Verify the creation of the PV by running the following command:
 +
@@ -164,9 +172,10 @@ spec:
   volumeMode: Filesystem
   resources:
     requests:
-      storage: 10Gi <1>
+      storage: 10Gi
 ----
-<1> The amount of storage available to the PVC. Adjust this value for your requirements.
++
+Adjust the `storage` value for your requirements.
 +
 .. Apply the PVC by running the following command:
 +
@@ -185,9 +194,10 @@ metadata:
   name: etcd-single-backup
   namespace: openshift-etcd
 spec:
-  pvcName: etcd-backup-pvc <1>
+  pvcName: etcd-backup-pvc
 ----
-<1> The name of the persistent volume claim (PVC) to save the backup to. Adjust this value according to your environment.
++
+Adjust the `pvcName` value according to your environment.
 +
 .. Apply the CR to start a single backup:
 +

modules/update-backup-etcd-database-before-update.adoc

@@ -0,0 +1,10 @@
+// Module included in the following assemblies:
+//
+// * edge_computing/day_2_core_cnf_clusters/updating/update-before-the-update.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="update-backup-etcd-database-before-update_{context}"]
+= Backup the etcd database before you proceed with the update
+
+[role="_abstract"]
+You must backup the etcd database before you proceed with the update.

modules/update-pause-worker-nodes-before-the-update.adoc

@@ -41,7 +41,7 @@ master  false
 mcp-1   true
 mcp-2   true
 ----
-
++
 [NOTE]
 ====
 The default control plane and worker `mcp` groups are not changed during an update.

post_installation_configuration/day_2_core_cnf_clusters/updating/update-before-the-update.adoc

@@ -11,10 +11,7 @@ Before you start the cluster update, you must pause worker nodes, back up the et
 
 include::modules/update-pause-worker-nodes-before-the-update.adoc[leveloffset=+1]
 
-[id="update-backup-etcd-database-before-update_{context}"]
-== Backup the etcd database before you proceed with the update
-
-You must backup the etcd database before you proceed with the update.
+include::modules/update-backup-etcd-database-before-update.adoc[leveloffset=+1]
 
 include::modules/backup-etcd.adoc[leveloffset=+2]