Updated code and docs to reflect correct terminology

- Updated instances of fsid with clusterid
- Updated instances of credentials/subject with user/key

Signed-off-by: ShyamsundarR <srangana@redhat.com>

examples/rbd/snapshotclass.yaml

@@ -10,8 +10,14 @@ parameters:
   # if using FQDN, make sure csi plugin's dns policy is appropriate.
   monitors: mon1:port,mon2:port,...
   # OR,
-  # Ceph cluster fsid, of the cluster to provision storage from
-  # clusterID: <ceph-fsid>
+  # String representing a Ceph cluster to provision storage from.
+  # Should be unique unique across all Ceph clusters in use for provisioning,
+  # cannot be greater than 36 bytes in length, and should remain immutable for
+  # the lifetime of the StorageClass in use.
+  # If using clusterID, ensure to create a secret, as in
+  # template-ceph-cluster-ID-secret.yaml, to accompany the string chosen to
+  # represent the Ceph cluster in clusterID
+  # clusterID: <cluster-id>
 
   csi.storage.k8s.io/snapshotter-secret-name: csi-rbd-secret
   csi.storage.k8s.io/snapshotter-secret-namespace: default

examples/rbd/storageclass.yaml

@@ -9,11 +9,14 @@ parameters:
    # if using FQDN, make sure csi plugin's dns policy is appropriate.
    monitors: mon1:port,mon2:port,...
    # OR,
-   # Ceph cluster fsid, of the cluster to provision storage from
-   # clusterID: <ceph-fsid>
-   # If using clusterID based configuration, CSI pods need to be passed in a
-   # secret named ceph-cluster-<cluster-fsid> that contains the cluster
-   # information. (as in the provided template-ceph-cluster-ID-secret.yaml)
+   # String representing a Ceph cluster to provision storage from.
+   # Should be unique unique across all Ceph clusters in use for provisioning,
+   # cannot be greater than 36 bytes in length, and should remain immutable for
+   # the lifetime of the StorageClass in use.
+   # If using clusterID, ensure to create a secret, as in
+   # template-ceph-cluster-ID-secret.yaml, to accompany the string chosen to
+   # represent the Ceph cluster in clusterID
+   # clusterID: <cluster-id>
    # OR,
    # if "monitors" parameter is not set, driver to get monitors from same
    # secret as admin/user credentials. "monValueFromSecret" provides the
@@ -32,7 +35,7 @@ parameters:
 
    # The secrets have to contain Ceph admin credentials.
    # NOTE: If using "clusterID" instead of "monitors" above, the following
-   # secrets MAY be added to the ceph-cluster-<cluster-fsid> secret and skipped
+   # secrets MAY be added to the ceph-cluster-<cluster-id> secret and skipped
    # here
    csi.storage.k8s.io/provisioner-secret-name: csi-rbd-secret
    csi.storage.k8s.io/provisioner-secret-namespace: default
@@ -41,7 +44,7 @@ parameters:
 
    # Ceph users for operating RBD
    # NOTE: If using "clusterID" instead of "monitors" above, the following
-   # IDs MAY be added to the ceph-cluster-<cluster-fsid> secret and skipped
+   # IDs MAY be added to the ceph-cluster-<cluster-id> secret and skipped
    # here
    adminid: admin
    userid: kubernetes

examples/rbd/template-ceph-cluster-ID-secret.yaml

@@ -6,11 +6,10 @@
 apiVersion: v1
 kind: Secret
 metadata:
-  # The <cluster-fsid> is used by the CSI plugin to uniquely identify and use a
-  #   Ceph cluster, hence the value MUST match the output of the following
-  #   command.
-  #   - Output of: `ceph fsid`
-  name: ceph-cluster-<cluster-fsid>
+  # The <cluster-id> is used by the CSI plugin to uniquely identify and use a
+  # Ceph cluster, the value MUST match the value provided as `clusterID` in the
+  # StorageClass
+  name: ceph-cluster-<cluster-id>
   namespace: default
 data:
   # Base64 encoded and comma separated Ceph cluster monitor list
@@ -24,7 +23,7 @@ data:
   # Substitute the entire string including angle braces, with the base64 value
   adminid: <BASE64-ENCODED-ID>
   # Base64 encoded key of the provisioner admin ID
-  #   - Output of: `ceph auth get-key client.admin | base64`
+  #   - Output of: `ceph auth get-key client.<admin-id> | base64`
   # Substitute the entire string including angle braces, with the base64 value
   adminkey: <BASE64-ENCODED-PASSWORD>
   # Base64 encoded user ID to use for publishing
@@ -32,6 +31,6 @@ data:
   # Substitute the entire string including angle braces, with the base64 value
   userid: <BASE64-ENCODED-ID>
   # Base64 encoded key of the publisher user ID
-  #   - Output of: `ceph auth get-key client.admin | base64`
+  #   - Output of: `ceph auth get-key client.<admin-id> | base64`
   # Substitute the entire string including angle braces, with the base64 value
   userkey: <BASE64-ENCODED-PASSWORD>

examples/rbd/template-csi-rbdplugin-patch.yaml

@@ -1,8 +1,17 @@
 ---
 # This is a patch to the existing daemonset deployment of CSI rbdplugin.
-# This is to be used when adding a new Ceph cluster to the CSI plugin.
+#
+# This is to be used when using `clusterID` instead of monitors or
+# monValueFromSecret in the StorageClass to specify the Ceph cluster to
+# provision storage from, AND when the value of `--configroot` option to the
+# CSI pods is NOT "k8s_objects".
+#
+# This patch file, patches in the specified secret for the 'clusterID' as a
+# volume, instead of the Ceph CSI plugin actively fetching and using kubernetes
+# secrets.
+#
 # NOTE: Update csi-rbdplugin-provisioner StatefulSet as well with similar patch
-# Post substituting the <cluster-fsid> in all places execute,
+# Post substituting the <cluster-id> in all places execute,
 #   `kubectl patch daemonset csi-rbdplugin --patch\
 #         "$(cat template-csi-rbdplugin-patch.yaml)"`
 #   to patch the statefulset deployment.
@@ -12,10 +21,10 @@ spec:
       containers:
         - name: csi-rbdplugin
           volumeMounts:
-            - name: ceph-cluster-<cluster-fsid>
-              mountPath: "/etc/csi-config/ceph-cluster-<cluster-fsid>"
+            - name: ceph-cluster-<cluster-id>
+              mountPath: "/etc/csi-config/ceph-cluster-<cluster-id>"
               readOnly: true
       volumes:
-        - name: ceph-cluster-<cluster-fsid>
+        - name: ceph-cluster-<cluster-id>
           secret:
-            secretName: ceph-cluster-<cluster-fsid>
+            secretName: ceph-cluster-<cluster-id>

examples/rbd/template-csi-rbdplugin-provisioner-patch.yaml

@@ -1,8 +1,17 @@
 ---
 # This is a patch to the existing statefulset deployment of CSI rbdplugin.
-# This is to be used when adding a new Ceph cluster to the CSI plugin.
+#
+# This is to be used when using `clusterID` instead of monitors or
+# monValueFromSecret in the StorageClass to specify the Ceph cluster to
+# provision storage from, AND when the value of `--configroot` option to the
+# CSI pods is NOT "k8s_objects".
+#
+# This patch file, patches in the specified secret for the 'clusterID' as a
+# volume, instead of the Ceph CSI plugin actively fetching and using kubernetes
+# secrets.
+#
 # NOTE: Update csi-rbdplugin DaemonSet as well with similar patch
-# Post substituting the <cluster-fsid> in all places execute,
+# Post substituting the <cluster-id> in all places execute,
 #   `kubectl patch statefulset csi-rbdplugin-provisioner --patch\
 #         "$(cat template-csi-rbdplugin-provisioner-patch.yaml)"`
 #   to patch the statefulset deployment.
@@ -12,10 +21,10 @@ spec:
       containers:
         - name: csi-rbdplugin
           volumeMounts:
-            - name: ceph-cluster-<cluster-fsid>
-              mountPath: "/etc/csi-config/ceph-cluster-<cluster-fsid>"
+            - name: ceph-cluster-<cluster-id>
+              mountPath: "/etc/csi-config/ceph-cluster-<cluster-id>"
               readOnly: true
       volumes:
-        - name: ceph-cluster-<cluster-fsid>
+        - name: ceph-cluster-<cluster-id>
           secret:
-            secretName: ceph-cluster-<cluster-fsid>
+            secretName: ceph-cluster-<cluster-id>