doc: Add prefix for naming subvolumes and snapshots

Updated storageclass and snapshotclass to include the name prefix for naming subvolumes and snapshots. Fixes: #1087 Signed-off-by: Yug Gupta <ygupta@redhat.com>
ceph · May 27, 2020 · 6cf7389 · 6cf7389
1 parent c2d4200
commit 6cf7389
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 2 deletions.
diff --git a/docs/deploy-cephfs.md b/docs/deploy-cephfs.md
@@ -83,7 +83,7 @@ is used to define in which namespace you want the configmaps to be stored
 | `fsName`                                                                                            | yes            | CephFS filesystem name into which the volume shall be created                                                                                                                                                           |
 | `mounter`                                                                                           | no             | Mount method to be used for this volume. Available options are `kernel` for Ceph kernel client and `fuse` for Ceph FUSE driver. Defaults to "default mounter".                                                          |
 | `pool`                                                                                              | no             | Ceph pool into which volume data shall be stored                                                                                                                                                                        |
-| `volumeNamePrefix`                                                                                  | no             | Prefix to use for naming volumes (defaults to `csi-vol-`).                                                                                                                                                    |
+| `volumeNamePrefix`                                                                                  | no             | Prefix to use for naming subvolumes (defaults to `csi-vol-`).                                                                                                                                                    |
 | `snapshotNamePrefix`                                                                                | no             | Prefix to use for naming snapshots (defaults to `csi-snap-`)
 | `kernelMountOptions`                                                                                | no             | Comma separated string of mount options accepted by cephfs kernel mounter, by default no options are passed. Check man mount.ceph for options.                                                                          |
 | `fuseMountOptions`                                                                                  | no             | Comma separated string of mount options accepted by ceph-fuse mounter, by default no options are passed.                                                                                                                |

diff --git a/docs/deploy-rbd.md b/docs/deploy-rbd.md
@@ -50,7 +50,7 @@ make image-cephcsi
 | `clusterID`                                                                                         | yes                  | String representing a Ceph cluster, must be 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 Ceph cluster in use |
 | `pool`                                                                                              | yes                  | Ceph pool into which the RBD image shall be created                                                                                                                                                                     |
 | `dataPool`                                                                                          | no                   | Ceph pool used for the data of the RBD images.                                                                                                                                                                          |
-| `volumeNamePrefix`                                                                                  | no                   | Prefix to use for naming RBD volume images (defaults to `csi-vol-`).                                                                                                                                                    |
+| `volumeNamePrefix`                                                                                  | no                   | Prefix to use for naming RBD images (defaults to `csi-vol-`).                                                                                                                                                    |
 | `snapshotNamePrefix`                                                                                | no                   | Prefix to use for naming RBD snapshot images (defaults to `csi-snap-`).                                                                                                                                                 |
 | `imageFeatures`                                                                                     | no                   | RBD image features. CSI RBD currently supports only `layering` feature. See [man pages](http://docs.ceph.com/docs/mimic/man/8/rbd/#cmdoption-rbd-image-feature)                                                         |
 | `csi.storage.k8s.io/provisioner-secret-name`, `csi.storage.k8s.io/node-stage-secret-name`           | yes (for Kubernetes) | name of the Kubernetes Secret object containing Ceph client credentials. Both parameters should have the same value                                                                                                     |

diff --git a/examples/cephfs/storageclass.yaml b/examples/cephfs/storageclass.yaml
@@ -41,6 +41,11 @@ parameters:
   # If omitted, default volume mounter will be used - this is
   # determined by probing for ceph-fuse and mount.ceph
   # mounter: kernel
+
+  # (optional) Prefix to use for naming subvolumes.
+  # If omitted, defaults to "csi-vol-".
+  # volumeNamePrefix: "foo-bar-"
+
 reclaimPolicy: Delete
 allowVolumeExpansion: true
 mountOptions:

diff --git a/examples/rbd/snapshotclass.yaml b/examples/rbd/snapshotclass.yaml
@@ -14,6 +14,10 @@ parameters:
   # represent the Ceph cluster in clusterID below
   clusterID: <cluster-id>
 
+  # Prefix to use for naming RBD snapshots.
+  # If omitted, defaults to "csi-snap-".
+  # snapshotNamePrefix: "foo-bar-"
+
   csi.storage.k8s.io/snapshotter-secret-name: csi-rbd-secret
   csi.storage.k8s.io/snapshotter-secret-namespace: default
 deletionPolicy: Delete
diff --git a/examples/rbd/storageclass.yaml b/examples/rbd/storageclass.yaml
@@ -43,6 +43,10 @@ parameters:
    # uncomment the following to use rbd-nbd as mounter on supported nodes
    # mounter: rbd-nbd
 
+   # Prefix to use for naming RBD images.
+   # If omitted, defaults to "csi-vol-".
+   # volumeNamePrefix: "foo-bar-"
+
    # Instruct the plugin it has to encrypt the volume
    # By default it is disabled. Valid values are "true" or "false".
    # A string is expected here, i.e. "true", not true.