Skip to content

Commit 1e95975

Browse files
authored
Merge pull request #713 from RaunakShah/update-readme
README changes to release-6.0 branch
2 parents a492b7f + ef831c9 commit 1e95975

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,8 @@ Read more about how to install the example webhook [here](deploy/kubernetes/webh
111111

112112
* `--kubeconfig <path>`: Path to Kubernetes client configuration that the webhook uses to connect to Kubernetes API server. When omitted, default token provided by Kubernetes will be used. This option is useful only when the snapshot controller does not run as a Kubernetes pod, e.g. for debugging.
113113

114+
* `--prevent-volume-mode-conversion`: Boolean that prevents an unauthorised user from modifying the volume mode when creating a PVC from an existing VolumeSnapshot. Only present as an alpha feature in `v6.0.0` and above.
115+
114116
#### Validating Webhook Validations
115117

116118
##### Volume Snapshot
@@ -122,9 +124,10 @@ Read more about how to install the example webhook [here](deploy/kubernetes/webh
122124
##### Volume Snapshot Content
123125

124126
* Spec.VolumeSnapshotRef.Name must not be an empty string on creation
125-
* Spec.VolumeSnapshotRef.Namespace must not be an empty stringon creation
127+
* Spec.VolumeSnapshotRef.Namespace must not be an empty string on creation
126128
* Spec.Source.VolumeHandle must not be changed on update requests
127129
* Spec.Source.SnapshotHandle must not be changed on update requests
130+
* Spec.SourceVolumeMode must not be changes on update requests
128131

129132
##### Volume Snapshot Classes
130133

@@ -173,6 +176,8 @@ Other than this, the NODE_NAME environment variable must be set where the CSI sn
173176

174177
* `--enable-distributed-snapshotting` : Enables each node to handle snapshots for the volumes local to that node. Off by default. It should be set to true only if `--node-deployment` parameter for the csi external snapshotter sidecar is set to true. See https://github.com/kubernetes-csi/external-snapshotter/blob/master/README.md#distributed-snapshotting for details.
175178

179+
* `--prevent-volume-mode-conversion`: Boolean that prevents an unauthorised user from modifying the volume mode when creating a PVC from an existing VolumeSnapshot. Only present as an alpha feature in `v6.0.0` and above.
180+
176181
#### Other recognized arguments
177182
* `--kubeconfig <path>`: Path to Kubernetes client configuration that the snapshot controller uses to connect to Kubernetes API server. When omitted, default token provided by Kubernetes will be used. This option is useful only when the snapshot controller does not run as a Kubernetes pod, e.g. for debugging.
178183

0 commit comments

Comments
 (0)