Merge pull request #68130 from lpettyjo/OSDOCS-7674

OSDOCS#7674:LSO option to wipe LVs

Author: lpettyjo

modules/persistent-storage-local-create-cr.adoc

@@ -46,23 +46,25 @@ spec:
           - ip-10-0-164-33
   storageClassDevices:
     - storageClassName: "local-sc" <3>
-      volumeMode: Filesystem <4>
-      fsType: xfs <5>
-      devicePaths: <6>
-        - /path/to/device <7>
+      forceWipeDevicesAndDestroyAllData: false <4>
+      volumeMode: Filesystem <5>
+      fsType: xfs <6>
+      devicePaths: <7>
+        - /path/to/device <8>
 ----
 <1> The namespace where the Local Storage Operator is installed.
 <2> Optional: A node selector containing a list of nodes where the local storage volumes are attached. This example uses the node hostnames, obtained from `oc get node`. If a value is not defined, then the Local Storage Operator will attempt to find matching disks on all available nodes.
 <3> The name of the storage class to use when creating persistent volume objects. The Local Storage Operator automatically creates the storage class if it does not exist. Be sure to use a storage class that uniquely identifies this set of local volumes.
-<4> The volume mode, either `Filesystem` or `Block`, that defines the type of local volumes.
+<4> This setting defines whether or not to call `wipefs`, which removes partition table signatures (magic strings) making the disk ready to use for Local Storage Operator (LSO) provisioning. No other data besides signatures is erased. The default is "false" (`wipefs` is not invoked). Setting `forceWipeDevicesAndDestroyAllData` to "true" can be useful in scenarios where previous data can remain on disks that need to be re-used. In these scenarios, setting this field to true eliminates the need for administrators to erase the disks manually. Such cases can include single-node OpenShift (SNO) cluster environments where a node can be redeployed multiple times or when using OpenShift Data Foundation (ODF), where previous data can remain on the disks planned to be consumed as object storage devices (OSDs).
+<5> The volume mode, either `Filesystem` or `Block`, that defines the type of local volumes.
 +
 [NOTE]
 ====
 A raw block volume (`volumeMode: Block`) is not formatted with a file system. Use this mode only if any application running on the pod can use raw block devices.
 ====
-<5> The file system that is created when the local volume is mounted for the first time.
-<6> The path containing a list of local storage devices to choose from.
-<7> Replace this value with your actual local disks filepath to the `LocalVolume` resource `by-id`, such as `/dev/disk/by-id/wwn`. PVs are created for these local disks when the provisioner is deployed successfully.
+<6> The file system that is created when the local volume is mounted for the first time.
+<7> The path containing a list of local storage devices to choose from.
+<8> Replace this value with your actual local disks filepath to the `LocalVolume` resource `by-id`, such as `/dev/disk/by-id/wwn`. PVs are created for these local disks when the provisioner is deployed successfully.
 +
 [NOTE]
 ====
@@ -90,16 +92,18 @@ spec:
           - ip-10-0-144-180
   storageClassDevices:
     - storageClassName: "localblock-sc" <3>
-      volumeMode: Block <4>
-      devicePaths: <5>
-        - /path/to/device <6>
+      forceWipeDevicesAndDestroyAllData: false <4>
+      volumeMode: Block <5>
+      devicePaths: <6>
+        - /path/to/device <7>
 ----
 <1> The namespace where the Local Storage Operator is installed.
 <2> Optional: A node selector containing a list of nodes where the local storage volumes are attached. This example uses the node hostnames, obtained from `oc get node`. If a value is not defined, then the Local Storage Operator will attempt to find matching disks on all available nodes.
 <3> The name of the storage class to use when creating persistent volume objects.
-<4> The volume mode, either `Filesystem` or `Block`, that defines the type of local volumes.
-<5> The path containing a list of local storage devices to choose from.
-<6> Replace this value with your actual local disks filepath to the `LocalVolume` resource `by-id`, such as `dev/disk/by-id/wwn`. PVs are created for these local disks when the provisioner is deployed successfully.
+<4> This setting defines whether or not to call `wipefs`, which removes partition table signatures (magic strings) making the disk ready to use for Local Storage Operator (LSO) provisioning. No other data besides signatures is erased. The default is "false" (`wipefs` is not invoked). Setting `forceWipeDevicesAndDestroyAllData` to "true" can be useful in scenarios where previous data can remain on disks that need to be re-used. In these scenarios, setting this field to true eliminates the need for administrators to erase the disks manually. Such cases can include single-node OpenShift (SNO) cluster environments where a node can be redeployed multiple times or when using OpenShift Data Foundation (ODF), where previous data can remain on the disks planned to be consumed as object storage devices (OSDs).
+<5> The volume mode, either `Filesystem` or `Block`, that defines the type of local volumes.
+<6> The path containing a list of local storage devices to choose from.
+<7> Replace this value with your actual local disks filepath to the `LocalVolume` resource `by-id`, such as `dev/disk/by-id/wwn`. PVs are created for these local disks when the provisioner is deployed successfully.
 +
 [NOTE]
 ====