Fix nits in comments

This commit is contained in:
Raunak Pradip Shah
2023-03-08 10:51:30 +05:30
parent b051cf0145
commit bc61409236
2 changed files with 12 additions and 11 deletions

View File

@@ -23,7 +23,7 @@ import (
snapshotv1 "github.com/kubernetes-csi/external-snapshotter/client/v6/apis/volumesnapshot/v1" snapshotv1 "github.com/kubernetes-csi/external-snapshotter/client/v6/apis/volumesnapshot/v1"
) )
// VolumeGroupSnapshotSpec defines the desired state of VolumeGroupSnapshot // VolumeGroupSnapshotSpec defines the desired state of a volume group snapshot.
type VolumeGroupSnapshotSpec struct { type VolumeGroupSnapshotSpec struct {
// Source specifies where a group snapshot will be created from. // Source specifies where a group snapshot will be created from.
// This field is immutable after creation. // This field is immutable after creation.
@@ -45,8 +45,8 @@ type VolumeGroupSnapshotSpec struct {
// Exactly one of its members must be set. // Exactly one of its members must be set.
// Members in VolumeGroupSnapshotSource are immutable. // Members in VolumeGroupSnapshotSource are immutable.
type VolumeGroupSnapshotSource struct { type VolumeGroupSnapshotSource struct {
// Selector is a label query over PersistentVolumeClaims that are to be grouped // Selector is a label query over persistent volume claims that are to be
// together for snapshotting. // grouped together for snapshotting.
// This labelSelector will be used to match the label added to a PVC. // This labelSelector will be used to match the label added to a PVC.
// If the label is added or removed to a volume after a group snapshot // If the label is added or removed to a volume after a group snapshot
// is created, the existing group snapshots won't be modified. // is created, the existing group snapshots won't be modified.
@@ -64,7 +64,7 @@ type VolumeGroupSnapshotSource struct {
VolumeGroupSnapshotContentName *string `json:"volumeGroupSnapshotContentName,omitempty" protobuf:"bytes,2,opt,name=volumeGroupSnapshotContentName"` VolumeGroupSnapshotContentName *string `json:"volumeGroupSnapshotContentName,omitempty" protobuf:"bytes,2,opt,name=volumeGroupSnapshotContentName"`
} }
// VolumeGroupSnapshotStatus defines the observed state of VolumeGroupSnapshot // VolumeGroupSnapshotStatus defines the observed state of volume group snapshot.
type VolumeGroupSnapshotStatus struct { type VolumeGroupSnapshotStatus struct {
// BoundVolumeGroupSnapshotContentName is the name of the VolumeGroupSnapshotContent // BoundVolumeGroupSnapshotContentName is the name of the VolumeGroupSnapshotContent
// object to which this VolumeGroupSnapshot object intends to bind to. // object to which this VolumeGroupSnapshot object intends to bind to.

View File

@@ -43,13 +43,14 @@ spec:
from. This field is immutable after creation. Required. from. This field is immutable after creation. Required.
properties: properties:
selector: selector:
description: Selector is a label query over PersistentVolumeClaims description: Selector is a label query over persistent volume
that are to be grouped together for snapshotting. This labelSelector claims that are to be grouped together for snapshotting. This
will be used to match the label added to a PVC. If the label labelSelector will be used to match the label added to a PVC.
is added or removed to a volume after a group snapshot is created, If the label is added or removed to a volume after a group snapshot
the existing group snapshots won't be modified. Once a VolumeGroupSnapshotContent is created, the existing group snapshots won't be modified.
is created and the sidecar starts to process it, the volume Once a VolumeGroupSnapshotContent is created and the sidecar
list will not change with retries. Required. starts to process it, the volume list will not change with retries.
Required.
properties: properties:
matchExpressions: matchExpressions:
description: matchExpressions is a list of label selector description: matchExpressions is a list of label selector