Merge pull request #50629 from lpettyjo/OCPBUGS-1421

OCPBUGS-1421: Add docs for RWX volume support

Author: lpettyjo

modules/persistent-storage-csi-vsphere-rwx.adoc

@@ -0,0 +1,31 @@
+// Module included in the following assemblies:
+//
+// storage/container_storage_interface/persistent-storage-csi-vsphere.adoc
+//
+
+[id="persistent-storage-csi-vsphere-rwx_{context}"]
+= ReadWriteMany vSphere volume support
+
+If the underlying vSphere environment supports the vSAN file service, then vSphere Container Storage Interface (CSI) Driver Operator installed by
+{product-title} supports provisioning of ReadWriteMany (RWX) volumes. If vSAN file service is not configured, then ReadWriteOnce (RWO) is the only access mode available. If you do not have vSAN file service configured, and you request RWX, the volume fails to get created and an error is logged.
+
+For more information about configuring the vSAN file service in your environment, see https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vsan.doc/GUID-82565B82-C911-42F7-85B1-E9EF973EE90C.html[vSAN File Service].
+
+You can request RWX volumes by making the following persistent volume claim (PVC):
+
+[source,yaml]
+----
+kind: PersistentVolumeClaim
+apiVersion: v1
+metadata:
+  name: myclaim
+spec:
+  resources:
+    requests:
+      storage: 1Gi
+  accessModes:
+     - ReadWriteMany
+  storageClassName: thin-csi
+----
+
+Requesting a PVC of the RWX volume type should result in provisioning of persistent volumes (PVs) backed by the vSAN file service.

modules/storage-persistent-storage-pv.adoc

@@ -154,14 +154,16 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
 |NFS  | ✅ | ✅ | ✅
 |OpenStack Manila  | - | - | ✅
 |{rh-storage-first}  | ✅ | - | ✅
-|VMware vSphere | ✅ | - |  -
+|VMware vSphere | ✅ | - | ✅ ^[3]^ 
 endif::[]
 
 |===
 [.small]
 --
 1. ReadWriteOnce (RWO) volumes cannot be mounted on multiple nodes. If a node fails, the system does not allow the attached RWO volume to be mounted on a new node because it is already assigned to the failed node. If you encounter a multi-attach error message as a result, force delete the pod on a shutdown or crashed node to avoid data loss in critical workloads, such as when dynamic persistent volumes are attached.
 2. Use a recreate deployment strategy for pods that rely on AWS EBS.
+3. If the underlying vSphere environment supports the vSAN file service, then the vSphere Container Storage Interface (CSI) Driver Operator installed by
+{product-title} supports provisioning of ReadWriteMany (RWX) volumes. If you do not have vSAN file service configured, and you request RWX, the volume fails to get created and an error is logged. For more information, see "Using Container Storage Interface" -> "VMware vSphere CSI Driver Operator".
 // GCE Persistent Disks, or Openstack Cinder PVs.
 --
 

storage/container_storage_interface/persistent-storage-csi-vsphere.adoc

@@ -40,6 +40,8 @@ include::modules/persistent-storage-csi-about.adoc[leveloffset=+1]
 
 include::modules/persistent-storage-csi-vsphere-stor-policy.adoc[leveloffset=+1]
 
+include::modules/persistent-storage-csi-vsphere-rwx.adoc[leveloffset=+1]
+
 include::modules/vmware-csi-driver-reqs.adoc[leveloffset=+1]
 
 To remove a third-party CSI driver, see xref:../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-install-issues_persistent-storage-csi-vsphere[Removing a third-party vSphere CSI Driver].

storage/understanding-persistent-storage.adoc

@@ -16,6 +16,10 @@ include::modules/storage-persistent-storage-reclaim.adoc[leveloffset=+2]
 
 include::modules/storage-persistent-storage-pv.adoc[leveloffset=+1]
 
+[role="_additional-resources"]
+.Additional resources
+* xref:../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-rwx_persistent-storage-csi-vsphere[ReadWriteMany vSphere volume support]
+
 include::modules/storage-persistent-storage-pvc.adoc[leveloffset=+1]
 
 ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]