kubernetes-csi / external-snapshotter

Sidecar container that watches Kubernetes Snapshot CRD objects and triggers CreateSnapshot/DeleteSnapshot against a CSI endpoint.
Apache License 2.0
484 stars 369 forks source link

need standard parameter keys for VolumeGroupSnapshotClass parameters #1122

Open jmccormick2001 opened 2 months ago

jmccormick2001 commented 2 months ago

What happened: There appears to not be any documentation on volume group specific parameters that could be passed in the VolumeGroupSnapshotClass. I have found that I can put any parameter I want in and it will be passed into the CreateVolumeGroupSnapshotRequest which works for my use case (e.g. to pass in storage device Secret and Namespace), however I would think there would be some standard parameter keys for passing in a secret name and namespace?

What you expected to happen:

I would expect some standard parameter keys for VolumeGroupSnapshotClass parameters specifically for secret name and namespace. I could not find documentation on this.

How to reproduce it:

Anything else we need to know?: looking at the source code, I noticed that snapshot.storage.kubernetes.io/deletion-secret-name: or snapshot.storage.kubernetes.io/deletion-secret-namespace are looked for and passed to CreateVolumeGroupSnapshot requests if these parameters are specified in the VolumeGroupSnapshotClass .... These parameter key names seem confusing to me given they make their way into a CreateVolumeGroupSnapshot request, also the key name is not like the other key names in terms of naming convention.

Environment: