Merge pull request #69929 from sr1kar99/lvms-unsupported-devices

OCPBUGS#24512: Added info on devices not supported for LVM Storage operations

Author: bscott-rh

modules/lvms-creating-logical-volume-manager-cluster.adoc

@@ -75,7 +75,7 @@ When configuring multiple device classes, you must specify the device path for e
 <2> Set `fstype` to `ext4` or `xfs`. By default, it is set to `xfs` if the setting is not specified.
 <3> Mandatory: The `LVMCluster` resource must contain a single default storage class. Set `default: false` for secondary device storage classes.
 If you are upgrading the `LVMCluster` resource from a previous version, you must specify a single default device class.
-<4> Optional. To control or restrict the volume group to your preferred devices, you can manually specify the local paths of the devices in the `deviceSelector` section of the `LVMCluster` YAML. The `paths` section refers to devices the `LVMCluster` adds, which means those paths must exist. The `optionalPaths` section refers to devices the `LVMCluster` might add. You must specify at least one of `paths` or `optionalPaths` when specifying the `deviceSelector` section. If you specify `paths`, it is not mandatory to specify `optionalPaths`. If you specify `optionalPaths`, it is not mandatory to specify `paths` but at least one optional path must be present on the node. If you do not specify any paths, it will add all unused devices on the node.
+<4> Optional. To control or restrict the volume group to your preferred devices, you can manually specify the local paths of the devices in the `deviceSelector` section of the `LVMCluster` YAML. The `paths` section refers to devices the `LVMCluster` adds, which means those paths must exist. The `optionalPaths` section refers to devices the `LVMCluster` might add. You must specify at least one of `paths` or `optionalPaths` when specifying the `deviceSelector` section. If you specify `paths`, it is not mandatory to specify `optionalPaths`. If you specify `optionalPaths`, it is not mandatory to specify `paths` but at least one optional path must be present on the node. If you do not specify any paths, then the `LVMCluster` adds the unused devices on the node.
 <5> Optional: To control what worker nodes the `LVMCluster` CR is applied to, specify a set of node selector labels.
 The specified labels must be present on the node in order for the `LVMCluster` to be scheduled on that node.
 

modules/lvms-unsupported-devices.adoc

@@ -0,0 +1,63 @@
+// Module included in the following assemblies:
+//
+// storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="lvms-unsupported-devices_{context}"]
+= Devices not supported by {lvms}
+
+When you are adding the paths to the devices in the `deviceSelector` section of the `LVMCluster` YAML, ensure that the devices are supported by {lvms}. If you add paths to the unsupported devices, then {lvms} excludes the devices to avoid complexity in managing logical volumes.
+
+If you do not specify any device path in the `deviceSelector`, then {lvms} adds only the unused devices that it supports. 
+
+[NOTE]
+====
+To get information about the devices, run the following command:
+[source,terminal]
+----
+$ lsblk --paths --json -o \
+NAME,ROTA,TYPE,SIZE,MODEL,VENDOR,RO,STATE,KNAME,SERIAL,PARTLABEL,FSTYPE
+----
+====
+
+{lvms} does not support the following devices:
+
+Read-only devices:: Devices with the `ro` parameter set to `true`.
+
+Suspended devices:: Devices with the `state` parameter set to `suspended`.
+
+ROM devices:: Devices with the `type` parameter set to `rom`.
+
+LVM partition devices:: Devices with the `type` parameter set to `lvm`. 
+
+Devices with invalid partition labels:: Devices with the `partlabel` parameter set to `bios`, `boot`, or `reserved`.
+
+Devices with an invalid filesystem:: Devices with the `fstype` parameter set to any value other than `null` or `LVM2_member`.
++
+[IMPORTANT]
+====
+{lvms} supports devices with `fstype` parameter set to `LVM2_member` only if the devices do not contain children devices.
+====
+
+Devices that are part of another volume group:: To get the information about the volume groups of the device, run the following command:
++
+[source, terminal]
+----
+$ pvs <device-name> <1>
+----
+<1> Replace `<device-name>` with the device name.
+
+Devices with bind mounts:: To get the mount points of a device, run the following command:
++
+[source, terminal]
+----
+$ cat /proc/1/mountinfo | grep <device-name> <1>
+----
+<1> Replace `<device-name>` with the device name.
+
+Devices that contain children devices::
+
+[NOTE]
+====
+It is recommended to wipe the device before using it in {lvms} to prevent unexpected behavior.
+====

storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc

@@ -60,6 +60,7 @@ include::modules/lvms-uninstalling-logical-volume-manager-operator-using-rhacm.a
 * xref:../../../storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc#lvms-reference-file_logical-volume-manager-storage[{lvms} reference YAML file]
 
 include::modules/lvms-creating-logical-volume-manager-cluster.adoc[leveloffset=+1]
+include::modules/lvms-unsupported-devices.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources