doc: updated doc for subvolumegroup creation

Signed-off-by: Praveen M <m.praveen@ibm.com>
ceph · Nov 2, 2023 · 238a88e · 238a88e
1 parent 6a4f624
commit 238a88e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/deploy/csi-config-map-sample.yaml b/deploy/csi-config-map-sample.yaml
@@ -20,6 +20,7 @@ kind: ConfigMap
 # NOTE: Make sure you don't add radosNamespace option to a currently in use
 # configuration as it will cause issues.
 # The field "cephFS.subvolumeGroup" is optional and defaults to "csi".
+# NOTE: The given subvolumeGroup must already exists in the pool.
 # The "cephFS.netNamespaceFilePath" fields are the various network namespace
 # path for the Ceph cluster identified by the <cluster-id>, This will be used
 # by the CephFS CSI plugin to execute the mount -t in the

diff --git a/docs/deploy-cephfs.md b/docs/deploy-cephfs.md
@@ -241,3 +241,10 @@ However, not all KMS are supported in order to be compatible with
 [fscrypt](https://github.com/google/fscrypt). In general KMS that
 either store secrets to use directly (Vault), or allow access to the
 plain password (Kubernetes Secrets) work.
+
+## CephFS Volume Provisioning 
+
+Requires subvolumegroup to be created before provisioning the volume.
+If the subvolumegroup provided in `ceph-csi-config` ConfigMap is missing
+in the ceph cluster, the PVC
+creation will fail and will stay in Pending state.