Use LocalObjectReference instead of ObjectReference in VolumeSnapshot

Instead of using a field with the resource name, this patch uses
LocalObjectReference in VolumeSnapshot too. This is being done for
simmetry with VolumeGroupSnapshotContent.

Signed-off-by: Leonardo Cecchi <[email protected]>

Author: leonardoce

client/apis/volumegroupsnapshot/v1alpha1/types.go

@@ -356,11 +356,11 @@ type VolumeGroupSnapshotContentStatus struct {
 // PVVolumeSnapshotContentPair represent a pair of PV names and
 // VolumeSnapshotContent names
 type PVVolumeSnapshotContentPair struct {
-	// PersistentVolumeName is the name of the persistent volume
-	PersistentVolumeName string `json:"persistentVolumeName,omitempty" protobuf:"bytes,1,opt,name=persistentVolumeName"`
+	// PersistentVolumeRef is a reference to the persistent volume resource
+	PersistentVolumeRef core_v1.LocalObjectReference `json:"persistentVolumeRef,omitempty" protobuf:"bytes,1,opt,name=persistentVolumeRef"`
 
-	// VolumeSnapshotContentName is the name of the volume snapshot content resource
-	VolumeSnapshotContentName string `json:"volumeSnapshotContentName,omitempty" protobuf:"bytes,2,opt,name=volumeSnapshotContentName"`
+	// VolumeSnapshotContentRef is a reference to the volume snapshot content resource
+	VolumeSnapshotContentRef core_v1.LocalObjectReference `json:"volumeSnapshotContentRef,omitempty" protobuf:"bytes,2,opt,name=volumeSnapshotContentRef"`
 }
 
 // VolumeGroupSnapshotContentSource represents the CSI source of a group snapshot.

client/apis/volumegroupsnapshot/v1alpha1/zz_generated.deepcopy.go

@@ -235,14 +235,26 @@ spec:
                   description: PVVolumeSnapshotContentPair represent a pair of PV
                     names and VolumeSnapshotContent names
                   properties:
-                    persistentVolumeName:
-                      description: PersistentVolumeName is the name of the persistent
-                        volume
-                      type: string
-                    volumeSnapshotContentName:
-                      description: VolumeSnapshotContentName is the name of the volume
-                        snapshot content resource
-                      type: string
+                    persistentVolumeRef:
+                      description: PersistentVolumeRef is a reference to the persistent
+                        volume resource
+                      properties:
+                        name:
+                          description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+                            TODO: Add other useful fields. apiVersion, kind, uid?'
+                          type: string
+                      type: object
+                      x-kubernetes-map-type: atomic
+                    volumeSnapshotContentRef:
+                      description: VolumeSnapshotContentRef is a reference to the
+                        volume snapshot content resource
+                      properties:
+                        name:
+                          description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+                            TODO: Add other useful fields. apiVersion, kind, uid?'
+                          type: string
+                      type: object
+                      x-kubernetes-map-type: atomic
                   type: object
                 type: array
               readyToUse:

client/config/crd/groupsnapshot.storage.k8s.io_volumegroupsnapshotcontents.yaml

@@ -567,9 +567,9 @@ func (ctrl *csiSnapshotCommonController) updateGroupSnapshotStatus(groupSnapshot
 	var pvcVolumeSnapshotRefList []crdv1alpha1.PVCVolumeSnapshotPair
 	if groupSnapshotContent.Status != nil && len(groupSnapshotContent.Status.PVVolumeSnapshotContentList) != 0 {
 		for _, contentRef := range groupSnapshotContent.Status.PVVolumeSnapshotContentList {
-			groupSnapshotContent, err := ctrl.contentLister.Get(contentRef.VolumeSnapshotContentName)
+			groupSnapshotContent, err := ctrl.contentLister.Get(contentRef.VolumeSnapshotContentRef.Name)
 			if err != nil {
-				return nil, fmt.Errorf("failed to get group snapshot content %s from group snapshot content store: %v", contentRef.VolumeSnapshotContentName, err)
+				return nil, fmt.Errorf("failed to get group snapshot content %s from group snapshot content store: %v", contentRef.VolumeSnapshotContentRef.Name, err)
 			}
 			pvcVolumeSnapshotRefList = append(pvcVolumeSnapshotRefList, crdv1alpha1.PVCVolumeSnapshotPair{
 				VolumeSnapshotRef: v1.LocalObjectReference{

pkg/common-controller/groupsnapshot_controller_helper.go

@@ -242,9 +242,9 @@ func (ctrl *csiSnapshotSideCarController) deleteCSIGroupSnapshotOperation(groupS
 	var snapshotIDs []string
 	if groupSnapshotContent.Status != nil && len(groupSnapshotContent.Status.PVVolumeSnapshotContentList) != 0 {
 		for _, contentRef := range groupSnapshotContent.Status.PVVolumeSnapshotContentList {
-			snapshotContent, err := ctrl.contentLister.Get(contentRef.VolumeSnapshotContentName)
+			snapshotContent, err := ctrl.contentLister.Get(contentRef.VolumeSnapshotContentRef.Name)
 			if err != nil {
-				return fmt.Errorf("failed to get snapshot content %s from snapshot content store: %v", contentRef.VolumeSnapshotContentName, err)
+				return fmt.Errorf("failed to get snapshot content %s from snapshot content store: %v", contentRef.VolumeSnapshotContentRef.Name, err)
 			}
 			snapshotIDs = append(snapshotIDs, *snapshotContent.Status.SnapshotHandle)
 		}
@@ -651,7 +651,9 @@ func (ctrl *csiSnapshotSideCarController) updateGroupSnapshotContentStatus(
 		}
 		for _, name := range snapshotContentNames {
 			newStatus.PVVolumeSnapshotContentList = append(newStatus.PVVolumeSnapshotContentList, crdv1alpha1.PVVolumeSnapshotContentPair{
-				VolumeSnapshotContentName: name,
+				VolumeSnapshotContentRef: v1.LocalObjectReference{
+					Name: name,
+				},
 			})
 		}
 		updated = true
@@ -675,7 +677,9 @@ func (ctrl *csiSnapshotSideCarController) updateGroupSnapshotContentStatus(
 		if len(newStatus.PVVolumeSnapshotContentList) == 0 {
 			for _, name := range snapshotContentNames {
 				newStatus.PVVolumeSnapshotContentList = append(newStatus.PVVolumeSnapshotContentList, crdv1alpha1.PVVolumeSnapshotContentPair{
-					VolumeSnapshotContentName: name,
+					VolumeSnapshotContentRef: v1.LocalObjectReference{
+						Name: name,
+					},
 				})
 			}
 			updated = true