From 9d21a678608cd47ec9cf35be18ec7445b198ef43 Mon Sep 17 00:00:00 2001 From: Praveen M Date: Thu, 2 Nov 2023 13:40:37 +0530 Subject: [PATCH] doc: updated doc for subvolumegroup creation Signed-off-by: Praveen M --- deploy/csi-config-map-sample.yaml | 1 + docs/deploy-cephfs.md | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/deploy/csi-config-map-sample.yaml b/deploy/csi-config-map-sample.yaml index b48e834a56f6..908aa1599a55 100644 --- 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 , 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 index 7e447d0f609e..bbb204d6b03b 100644 --- a/docs/deploy-cephfs.md +++ b/docs/deploy-cephfs.md @@ -241,3 +241,11 @@ 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. \ No newline at end of file