doc: Add documentation about --setmetadata option

Fixes: ceph#2874 Signed-off-by: Prasanna Kumar Kalever <[email protected]>
chenhuazhong · Jun 28, 2022 · af0bdaf · af0bdaf
1 parent dc738b9
commit af0bdaf
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/charts/ceph-csi-rbd/README.md b/charts/ceph-csi-rbd/README.md
@@ -112,6 +112,7 @@ charts and their default values.
 | `provisioner.skipForceFlatten`                 | Skip image flattening if kernel support mapping of rbd images which has the deep-flatten feature                                                     | `false`                                            |
 | `provisioner.timeout`                          | GRPC timeout for waiting for creation or deletion of a volume                                                                                        | `60s`                                              |
 | `provisioner.clustername`                      | Cluster name to set on the RBD image                                                                                                                 | ""                                                 |
+| `provisioner.setmetadata`                      | Set metadata on volume                                                                                                                               | `true`                                             |
 | `provisioner.priorityClassName`                | Set user created priorityclassName for csi provisioner pods. Default is `system-cluster-critical` which is less priority than `system-node-critical` | `system-cluster-critical`                          |
 | `provisioner.profiling.enabled`                | Specifies whether profiling should be enabled                                                                                                        | `false`                                            |
 | `provisioner.provisioner.image.repository`     | Specifies the csi-provisioner image repository URL                                                                                                   | `registry.k8s.io/sig-storage/csi-provisioner`           |

diff --git a/docs/deploy-rbd.md b/docs/deploy-rbd.md
@@ -47,6 +47,7 @@ make image-cephcsi
 | `--rbdsoftmaxclonedepth` | `4`                           | Soft limit for maximum number of nested volume clones that are taken before a flatten occurs                                                                                                                                                                                         |
 | `--skipforceflatten`     | `false`                       | skip image flattening on kernel < 5.2 which support mapping of rbd images which has the deep-flatten feature                                                                                                                                                                         |
 | `--maxsnapshotsonimage`  | `450`                         | Maximum number of snapshots allowed on rbd image without flattening                                                                                                                                                                                                                  |
+| `--setmetadata`          | `false`                       | Set metadata on volume                                                                                                                                                                                                                                                               |
 
 **Available volume parameters:**