From d85a26ef55634bdf380cc67d1b886426b7746fc5 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 | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/deploy/csi-config-map-sample.yaml b/deploy/csi-config-map-sample.yaml index b48e834a56f6..c64d26cf4190 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 exist in the filesystem. # 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..d908ff141e43 100644 --- a/docs/deploy-cephfs.md +++ b/docs/deploy-cephfs.md @@ -241,3 +241,9 @@ 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 PVC Provisioning + +Requires subvolumegroup to be created before provisioning the PVC. +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.