From 7a315b8cbd36100cf5b6bc83e58508eccce1603c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9CShauna=20Diaz=E2=80=9D?= <shdiaz@redhat.com>
Date: Mon, 7 Aug 2023 13:57:52 -0400
Subject: [PATCH] OCPBUGS-16043: Clarify mountOptions for MicroShift

---
 ...tanding-persistent-storage-microshift.adoc |  6 ++++
 modules/storage-persistent-storage-pv.adoc    | 29 +++++++++++++++++++
 modules/storage-persistent-storage-pvc.adoc   |  8 ++---
 3 files changed, 39 insertions(+), 4 deletions(-)

diff --git a/microshift_storage/understanding-persistent-storage-microshift.adoc b/microshift_storage/understanding-persistent-storage-microshift.adoc
index 3f2974c87b..8cf6173c1c 100644
--- a/microshift_storage/understanding-persistent-storage-microshift.adoc
+++ b/microshift_storage/understanding-persistent-storage-microshift.adoc
@@ -23,6 +23,12 @@ include::modules/storage-persistent-storage-reclaim.adoc[leveloffset=+2]
 
 include::modules/storage-persistent-storage-pv.adoc[leveloffset=+1]
 
+ifdef::microshift[]
+[role="_additional-resources"]
+.Additional resources
+* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/managing_file_systems/mounting-file-systems_managing-file-systems#common-mount-options_mounting-file-systems[Common mount options]
+endif::microshift[]
+
 include::modules/storage-persistent-storage-pvc.adoc[leveloffset=+1]
 
 include::modules/storage-persistent-storage-fsGroup.adoc[leveloffset=+1]
diff --git a/modules/storage-persistent-storage-pv.adoc b/modules/storage-persistent-storage-pv.adoc
index ee1badd1c2..b98538fc2b 100644
--- a/modules/storage-persistent-storage-pv.adoc
+++ b/modules/storage-persistent-storage-pv.adoc
@@ -252,6 +252,7 @@ You can specify mount options while mounting a PV by using the attribute `mountO
 
 For example:
 
+ifndef::microshift[]
 .Mount options example
 [source,yaml]
 ----
@@ -301,3 +302,31 @@ ifndef::openshift-dedicated,openshift-rosa[]
 Fibre Channel and HostPath PVs do not support mount options.
 ====
 endif::openshift-dedicated,openshift-rosa[]
+endif::microshift[]
+
+ifdef::microshift[]
+.Mount options example
+[source,yaml]
+----
+apiVersion: storage.k8s.io/v1
+kind: StorageClass
+metadata:
+  annotations:
+    storageclass.kubernetes.io/is-default-class: "true"
+  name: topolvm-provisioner
+mountOptions:
+  - uid=1500
+  - gid=1500
+parameters:
+  csi.storage.k8s.io/fstype: xfs
+provisioner: topolvm.io
+reclaimPolicy: Delete
+volumeBindingMode: WaitForFirstConsumer
+allowVolumeExpansion: true
+----
+
+[NOTE]
+====
+`mountOptions` are not validated. Incorrect values will cause the mount to fail and an event to be logged to the PVC.
+====
+endif::microshift[]
\ No newline at end of file
diff --git a/modules/storage-persistent-storage-pvc.adoc b/modules/storage-persistent-storage-pvc.adoc
index 9688508e7a..d68ee13127 100644
--- a/modules/storage-persistent-storage-pvc.adoc
+++ b/modules/storage-persistent-storage-pvc.adoc
@@ -27,10 +27,10 @@ spec:
 status:
   ...
 ----
-<1> Name of the PVC
-<2> The access mode, defining the read-write and mount permissions
-<3> The amount of storage available to the PVC
-<4> Name of the `StorageClass` required by the claim
+<1> Name of the PVC.
+<2> The access mode, defining the read-write and mount permissions.
+<3> The amount of storage available to the PVC.
+<4> Name of the `StorageClass` required by the claim.
 
 [id="pvc-storage-class_{context}"]
 == Storage classes