format comments

Author: dbug-dk

pkg/controllers/collaset/synccontrol/sync_control.go

@@ -713,7 +713,7 @@ func (r *RealSyncControl) Update(
 			continue
 		}
 
-		// fulfillPodUpdateInfo to all not updatedRevision pod
+		// 3.1 fulfillPodUpdateInfo to all not updatedRevision pod
 		if err = updater.FulfillPodUpdatedInfo(resources.UpdatedRevision, podInfo); err != nil {
 			logger.Error(err, fmt.Sprintf("fail to analyse pod %s/%s in-place update support", podInfo.Namespace, podInfo.Name))
 			continue
@@ -726,10 +726,13 @@ func (r *RealSyncControl) Update(
 		podCh <- podToUpdate[i]
 	}
 
+	// 4. begin pod update lifecycle
 	updating, err = updater.BeginUpdatePod(resources, podCh)
 	if err != nil {
 		return updating, recordedRequeueAfter, err
 	}
+
+	// 5. filter pods not allow to ops now, such as OperationDelaySeconds strategy
 	recordedRequeueAfter, err = updater.FilterAllowOpsPods(podToUpdate, ownedIDs, resources, podCh)
 	if err != nil {
 		collasetutils.AddOrUpdateCondition(resources.NewStatus,
@@ -767,7 +770,7 @@ func (r *RealSyncControl) Update(
 		collasetutils.AddOrUpdateCondition(resources.NewStatus, appsv1alpha1.CollaSetUpdate, nil, "Updated", "")
 	}
 
-	// try to finish all Pods'PodOpsLifecycle if its update is finished.
+	// 7. try to finish all Pods'PodOpsLifecycle if its update is finished.
 	succCount, err = controllerutils.SlowStartBatch(len(podUpdateInfos), controllerutils.SlowStartInitialBatchSize, false, func(i int, _ error) error {
 		podInfo := podUpdateInfos[i]
 

pkg/controllers/collaset/synccontrol/update.go

@@ -351,7 +351,7 @@ func (u *GenericPodUpdater) FilterAllowOpsPods(podToUpdate []*PodUpdateInfo, own
 		// if Pod has not been updated, update it.
 		podCh <- podToUpdate[i]
 	}
-	// 4. mark Pod to use updated revision before updating it.
+	// mark Pod to use updated revision before updating it.
 	if needUpdateContext {
 		u.recorder.Eventf(u.collaSet, corev1.EventTypeNormal, "UpdateToPodContext", "try to update ResourceContext for CollaSet")
 		err := retry.RetryOnConflict(retry.DefaultRetry, func() error {
@@ -363,7 +363,6 @@ func (u *GenericPodUpdater) FilterAllowOpsPods(podToUpdate []*PodUpdateInfo, own
 }
 
 func (u *GenericPodUpdater) FinishUpdatePod(podInfo *PodUpdateInfo) error {
-	//u.recorder.Eventf().V(1).Info("try to finish update PodOpsLifecycle for Pod", "pod", commonutils.ObjectKeyString(podInfo.Pod))
 	if updated, err := podopslifecycle.Finish(u.Client, collasetutils.UpdateOpsLifecycleAdapter, podInfo.Pod); err != nil {
 		return fmt.Errorf("failed to finish PodOpsLifecycle for updating Pod %s/%s: %s", podInfo.Namespace, podInfo.Name, err)
 	} else if updated {
@@ -493,7 +492,7 @@ func (u *inPlaceIfPossibleUpdater) FulfillPodUpdatedInfo(
 
 func (u *inPlaceIfPossibleUpdater) UpgradePod(podInfo *PodUpdateInfo) error {
 	if podInfo.OnlyMetadataChanged || podInfo.InPlaceUpdateSupport {
-		// 6.1 if pod template changes only include metadata or support in-place update, just apply these changes to pod directly
+		// if pod template changes only include metadata or support in-place update, just apply these changes to pod directly
 		if err := u.podControl.UpdatePod(podInfo.UpdatedPod); err != nil {
 			return fmt.Errorf("fail to update Pod %s/%s when updating by in-place: %s", podInfo.Namespace, podInfo.Name, err)
 		} else {
@@ -510,7 +509,7 @@ func (u *inPlaceIfPossibleUpdater) UpgradePod(podInfo *PodUpdateInfo) error {
 			}
 		}
 	} else {
-		// 6.2 if pod has changes not in-place supported, recreate it
+		// if pod has changes not in-place supported, recreate it
 		return recreatePod(u.collaSet, podInfo, u.podControl, u.recorder)
 	}
 	return nil