Update CNSUnregisterVolume's status using Status subresource client (#3491)

Author: kolluria

pkg/apis/cnsoperator/config/cnsunregistervolume_crd.yaml

@@ -62,6 +62,8 @@ spec:
         type: object
     served: true
     storage: true
+    subresources:
+      status: {}
 status:
   acceptedNames:
     kind: ""

pkg/kubernetes/kubernetes.go

@@ -694,3 +694,19 @@ func PatchFinalizers(ctx context.Context, c client.Client, obj client.Object, fi
 	patch := client.MergeFromWithOptions(original, client.MergeFromWithOptimisticLock{})
 	return c.Patch(ctx, obj, patch)
 }
+
+// UpdateStatus updates the status subresource of the given Kubernetes object.
+// If the object is a Custom Resource, make sure that the `subresources` field in the
+// CustomResourceDefinition includes `status` to enable status subresource updates.
+func UpdateStatus(ctx context.Context, c client.Client, obj client.Object) error {
+	log := logger.GetLogger(ctx)
+	if err := c.Status().Update(ctx, obj); err != nil {
+		log.Errorf("Failed to update status for %s %s/%s: %v", obj.GetObjectKind().GroupVersionKind().Kind,
+			obj.GetNamespace(), obj.GetName(), err)
+		return err
+	}
+
+	log.Infof("Successfully updated status for %s %s/%s", obj.GetObjectKind().GroupVersionKind().Kind,
+		obj.GetNamespace(), obj.GetName())
+	return nil
+}

pkg/syncer/cnsoperator/controller/cnsunregistervolume/cnsunregistervolume_controller.go

@@ -404,12 +404,8 @@ func validateVolumeNotInUse(ctx context.Context, volumeID string, pvcName string
 // instance.
 func setInstanceError(ctx context.Context, r *ReconcileCnsUnregisterVolume,
 	instance *cnsunregistervolumev1alpha1.CnsUnregisterVolume, errMsg string) {
-	log := logger.GetLogger(ctx)
 	instance.Status.Error = errMsg
-	err := updateCnsUnregisterVolume(ctx, r.client, instance)
-	if err != nil {
-		log.Errorf("updateCnsUnregisterVolume failed. err: %v", err)
-	}
+	_ = k8s.UpdateStatus(ctx, r.client, instance)
 	recordEvent(ctx, r, instance, v1.EventTypeWarning, errMsg)
 }
 
@@ -419,10 +415,11 @@ func setInstanceSuccess(ctx context.Context, r *ReconcileCnsUnregisterVolume,
 	instance *cnsunregistervolumev1alpha1.CnsUnregisterVolume, msg string) error {
 	instance.Status.Unregistered = true
 	instance.Status.Error = ""
-	err := updateCnsUnregisterVolume(ctx, r.client, instance)
+	err := k8s.UpdateStatus(ctx, r.client, instance)
 	if err != nil {
 		return err
 	}
+
 	recordEvent(ctx, r, instance, v1.EventTypeNormal, msg)
 	return nil
 }
@@ -453,15 +450,3 @@ func recordEvent(ctx context.Context, r *ReconcileCnsUnregisterVolume,
 		backOffDurationMapMutex.Unlock()
 	}
 }
-
-// updateCnsUnregisterVolume updates the CnsUnregisterVolume instance in K8S.
-func updateCnsUnregisterVolume(ctx context.Context, client client.Client,
-	instance *cnsunregistervolumev1alpha1.CnsUnregisterVolume) error {
-	log := logger.GetLogger(ctx)
-	err := client.Update(ctx, instance)
-	if err != nil {
-		log.Errorf("Failed to update CnsUnregisterVolume instance: %q on namespace: %q. Error: %+v",
-			instance.Name, instance.Namespace, err)
-	}
-	return err
-}