Rename nsx restore annotation (#1271)

Author: yanjunz97

pkg/controllers/common/utils.go

@@ -233,7 +233,7 @@ func UnlockSubnetSet(uuid types.UID, subnetSetLock *sync.Mutex) {
 	}
 }
 
-func UpdateRestoreAnnotation(client k8sclient.Client, ctx context.Context, obj k8sclient.Object, value string) error {
+func UpdateReconfigureNicAnnotation(client k8sclient.Client, ctx context.Context, obj k8sclient.Object, value string) error {
 	key := types.NamespacedName{Namespace: obj.GetNamespace(), Name: obj.GetName()}
 	err := client.Get(ctx, key, obj)
 	if err != nil {
@@ -244,7 +244,7 @@ func UpdateRestoreAnnotation(client k8sclient.Client, ctx context.Context, obj k
 	if anno == nil {
 		anno = map[string]string{}
 	}
-	restoreValue, ok := anno[servicecommon.AnnotationRestore]
+	restoreValue, ok := anno[servicecommon.AnnotationReconfigureNic]
 	if ok {
 		// Append the value to annotation if it is an interface name
 		if restoreValue == "" || value == "true" {
@@ -255,7 +255,7 @@ func UpdateRestoreAnnotation(client k8sclient.Client, ctx context.Context, obj k
 	} else {
 		restoreValue = value
 	}
-	anno[servicecommon.AnnotationRestore] = restoreValue
+	anno[servicecommon.AnnotationReconfigureNic] = restoreValue
 	obj.SetAnnotations(anno)
 	return client.Update(ctx, obj)
 }

pkg/controllers/pod/pod_controller.go

@@ -204,7 +204,7 @@ func (r *PodReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.R
 			retry.OnError(util.K8sClientRetry, func(err error) bool {
 				return err != nil
 			}, func() error {
-				return common.UpdateRestoreAnnotation(r.Client, ctx, pod, "true")
+				return common.UpdateReconfigureNicAnnotation(r.Client, ctx, pod, "true")
 			})
 		}
 	} else {

pkg/controllers/pod/pod_controller_test.go

@@ -298,7 +298,7 @@ func TestPodReconciler_Reconcile(t *testing.T) {
 						assert.Equal(t, v1.PodReady, pod.Status.Conditions[0].Type)
 						return nil
 					})
-				patches.ApplyFunc(common.UpdateRestoreAnnotation, func(client client.Client, ctx context.Context, obj client.Object, value string) error {
+				patches.ApplyFunc(common.UpdateReconfigureNicAnnotation, func(client client.Client, ctx context.Context, obj client.Object, value string) error {
 					assert.Equal(t, "true", value)
 					return nil
 				})

pkg/controllers/subnetport/subnetport_controller.go

@@ -221,15 +221,15 @@ func (r *SubnetPortReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 					retry.OnError(util.K8sClientRetry, func(err error) bool {
 						return err != nil
 					}, func() error {
-						return common.UpdateRestoreAnnotation(r.Client, ctx, subnetPort, "cpvm")
+						return common.UpdateReconfigureNicAnnotation(r.Client, ctx, subnetPort, "cpvm")
 					})
 				}
 			}
 			if vm != nil {
 				retry.OnError(util.K8sClientRetry, func(err error) bool {
 					return err != nil
 				}, func() error {
-					return common.UpdateRestoreAnnotation(r.Client, ctx, vm, nicName)
+					return common.UpdateReconfigureNicAnnotation(r.Client, ctx, vm, nicName)
 				})
 			}
 		}

pkg/controllers/subnetport/subnetport_controller_test.go

@@ -431,7 +431,7 @@ func TestSubnetPortReconciler_Reconcile(t *testing.T) {
 				return nil
 			})
 		k8sClient.EXPECT().Update(gomock.Any(), gomock.Any()).Do(func(ctx context.Context, obj client.Object, opts ...client.UpdateOption) error {
-			assert.Equal(t, "cpvm", obj.GetAnnotations()[servicecommon.AnnotationRestore])
+			assert.Equal(t, "cpvm", obj.GetAnnotations()[servicecommon.AnnotationReconfigureNic])
 			return nil
 		})
 		_, ret := r.Reconcile(ctx, req)

pkg/nsx/services/common/types.go

@@ -94,7 +94,7 @@ const (
 	AnnotationDefaultNetworkConfig     string = "nsx.vmware.com/default"
 	AnnotationAttachmentRef            string = "nsx.vmware.com/attachment_ref"
 	AnnotationAssociatedResource       string = "nsx.vmware.com/associated-resource"
-	AnnotationRestore                  string = "nsx/restore"
+	AnnotationReconfigureNic           string = "nsx/reconfigure-nic"
 	AnnotationPodMAC                   string = "nsx.vmware.com/mac"
 	LabelCPVM                          string = "iaas.vmware.com/is-cpvm-subnetport"
 	TagScopePodName                    string = "nsx-op/pod_name"