doc: Add hint that the userID must not include the client. prefix

Signed-off-by: Matthias Linhuber <[email protected]>
ceph · Jan 15, 2025 · bdd7c5a · bdd7c5a
1 parent e89fe5a
commit bdd7c5a
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 0 deletions.
diff --git a/charts/ceph-csi-cephfs/values.yaml b/charts/ceph-csi-cephfs/values.yaml
@@ -383,6 +383,7 @@ secret:
   # Key values correspond to a user name and its key, as defined in the
   # ceph cluster. User ID should have required access to the 'pool'
   # specified in the storage class
+  # The userID must not include the "client." prefix!
   userID: <plaintext ID>
   userKey: <Ceph auth key corresponding to the userID above>
 

diff --git a/charts/ceph-csi-rbd/values.yaml b/charts/ceph-csi-rbd/values.yaml
@@ -538,6 +538,7 @@ secret:
   # Key values correspond to a user name and its key, as defined in the
   # ceph cluster. User ID should have required access to the 'pool'
   # specified in the storage class
+  # The userID must not include the "client." prefix!
   userID: <plaintext ID>
   userKey: <Ceph auth key corresponding to userID above>
   # Encryption passphrase

diff --git a/examples/cephfs/secret.yaml b/examples/cephfs/secret.yaml
@@ -6,6 +6,7 @@ metadata:
   namespace: default
 stringData:
   # Required for statically and dynamically provisioned volumes
+  # The userID must not include the "client." prefix!
   userID: <plaintext ID>
   userKey: <Ceph auth key corresponding to ID above>
 

diff --git a/examples/rbd/secret.yaml b/examples/rbd/secret.yaml
@@ -8,6 +8,7 @@ stringData:
   # Key values correspond to a user name and its key, as defined in the
   # ceph cluster. User ID should have required access to the 'pool'
   # specified in the storage class
+  # The userID must not include the "client." prefix!
   userID: <plaintext ID>
   userKey: <Ceph auth key corresponding to ID above>