Rewrite rollout controller code

Signed-off-by: liheng.zms <[email protected]>

api/v1alpha1/rollout_types.go

@@ -25,6 +25,23 @@ import (
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
 // NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
 
+const (
+	// RolloutIDLabel is set to workload labels.
+	// RolloutIDLabel is designed to distinguish each workload revision publications.
+	// The value of RolloutIDLabel corresponds Rollout.Spec.RolloutID.
+	RolloutIDLabel = "rollouts.kruise.io/rollout-id"
+
+	// RolloutBatchIDLabel is patched in pod labels.
+	// RolloutBatchIDLabel is the label key of batch id that will be patched to pods during rollout.
+	// Only when RolloutIDLabel is set, RolloutBatchIDLabel will be patched.
+	// Users can use RolloutIDLabel and RolloutBatchIDLabel to select the pods that are upgraded in some certain batch and release.
+	RolloutBatchIDLabel = "rollouts.kruise.io/rollout-batch-id"
+
+	// RollbackInBatchAnnotation is set to rollout annotations.
+	// RollbackInBatchAnnotation allow use disable quick rollback, and will roll back in batch style.
+	RollbackInBatchAnnotation = "rollouts.kruise.io/rollback-in-batch"
+)
+
 // RolloutSpec defines the desired state of Rollout
 type RolloutSpec struct {
 	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
@@ -33,9 +50,11 @@ type RolloutSpec struct {
 	ObjectRef ObjectRef `json:"objectRef"`
 	// rollout strategy
 	Strategy RolloutStrategy `json:"strategy"`
+	// DeprecatedRolloutID is the deprecated field.
+	// It is recommended that configure RolloutId in workload.annotations[rollouts.kruise.io/rollout-id].
 	// RolloutID should be changed before each workload revision publication.
 	// It is to distinguish consecutive multiple workload publications and rollout progress.
-	RolloutID string `json:"rolloutID,omitempty"`
+	DeprecatedRolloutID string `json:"rolloutID,omitempty"`
 }
 
 type ObjectRef struct {
@@ -158,17 +177,12 @@ type RolloutStatus struct {
 
 	// observedGeneration is the most recent generation observed for this Rollout.
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
-	// CanaryRevision the hash of the canary pod template
+	// Canary describes the state of the canary rollout
 	// +optional
-	//CanaryRevision string `json:"canaryRevision,omitempty"`
-	// StableRevision indicates the revision pods that has successfully rolled out
-	StableRevision string `json:"stableRevision,omitempty"`
+	CanaryStatus *CanaryStatus `json:"canaryStatus,omitempty"`
 	// Conditions a list of conditions a rollout can have.
 	// +optional
 	Conditions []RolloutCondition `json:"conditions,omitempty"`
-	// Canary describes the state of the canary rollout
-	// +optional
-	CanaryStatus *CanaryStatus `json:"canaryStatus,omitempty"`
 	// +optional
 	//BlueGreenStatus *BlueGreenStatus `json:"blueGreenStatus,omitempty"`
 	// Phase is the rollout phase.
@@ -227,11 +241,10 @@ type CanaryStatus struct {
 	ObservedRolloutID string `json:"observedRolloutID,omitempty"`
 	// RolloutHash from rollout.spec object
 	RolloutHash string `json:"rolloutHash,omitempty"`
-	// CanaryService holds the name of a service which selects pods with canary version and don't select any pods with stable version.
-	CanaryService string `json:"canaryService"`
+	// StableRevision indicates the revision of stable pods
+	StableRevision string `json:"stableRevision,omitempty"`
 	// CanaryRevision is calculated by rollout based on podTemplateHash, and the internal logic flow uses
 	// It may be different from rs podTemplateHash in different k8s versions, so it cannot be used as service selector label
-	// +optional
 	CanaryRevision string `json:"canaryRevision"`
 	// pod template hash is used as service selector label
 	PodTemplateHash string `json:"podTemplateHash"`

config/crd/bases/rollouts.kruise.io_rollouts.yaml

@@ -81,9 +81,11 @@ spec:
                     type: object
                 type: object
               rolloutID:
-                description: RolloutID should be changed before each workload revision
-                  publication. It is to distinguish consecutive multiple workload
-                  publications and rollout progress.
+                description: DeprecatedRolloutID is the deprecated field. It is recommended
+                  that configure RolloutId in workload.annotations[rollouts.kruise.io/rollout-id].
+                  RolloutID should be changed before each workload revision publication.
+                  It is to distinguish consecutive multiple workload publications
+                  and rollout progress.
                 type: string
               strategy:
                 description: rollout strategy
@@ -202,11 +204,6 @@ spec:
                       different from rs podTemplateHash in different k8s versions,
                       so it cannot be used as service selector label
                     type: string
-                  canaryService:
-                    description: CanaryService holds the name of a service which selects
-                      pods with canary version and don't select any pods with stable
-                      version.
-                    type: string
                   currentStepIndex:
                     description: CurrentStepIndex defines the current step of the
                       rollout is on. If the current step index is null, the controller
@@ -235,10 +232,13 @@ spec:
                   rolloutHash:
                     description: RolloutHash from rollout.spec object
                     type: string
+                  stableRevision:
+                    description: StableRevision indicates the revision of stable pods
+                    type: string
                 required:
                 - canaryReadyReplicas
                 - canaryReplicas
-                - canaryService
+                - canaryRevision
                 - currentStepState
                 - podTemplateHash
                 type: object
@@ -290,11 +290,6 @@ spec:
                 description: BlueGreenStatus *BlueGreenStatus `json:"blueGreenStatus,omitempty"`
                   Phase is the rollout phase.
                 type: string
-              stableRevision:
-                description: CanaryRevision the hash of the canary pod template CanaryRevision
-                  string `json:"canaryRevision,omitempty"` StableRevision indicates
-                  the revision pods that has successfully rolled out
-                type: string
             type: object
         type: object
     served: true

main.go

@@ -26,7 +26,6 @@ import (
 	br "github.com/openkruise/rollouts/pkg/controller/batchrelease"
 	"github.com/openkruise/rollouts/pkg/controller/rollout"
 	"github.com/openkruise/rollouts/pkg/controller/rollouthistory"
-	"github.com/openkruise/rollouts/pkg/util"
 	utilclient "github.com/openkruise/rollouts/pkg/util/client"
 	utilfeature "github.com/openkruise/rollouts/pkg/util/feature"
 	"github.com/openkruise/rollouts/pkg/webhook"
@@ -102,7 +101,6 @@ func main() {
 	if err = (&rollout.RolloutReconciler{
 		Client:   mgr.GetClient(),
 		Scheme:   mgr.GetScheme(),
-		Finder:   util.NewControllerFinder(mgr.GetClient()),
 		Recorder: mgr.GetEventRecorderFor("rollout-controller"),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "Rollout")

pkg/controller/batchrelease/batchrelease_status.go

@@ -220,7 +220,7 @@ func isWorkloadRevisionChanged(event workloads.WorkloadEventType, release *v1alp
 }
 
 func isWorkloadRollbackInBatch(event workloads.WorkloadEventType, release *v1alpha1.BatchRelease) bool {
-	return (event == workloads.WorkloadRollbackInBatch || release.Annotations[util.RollbackInBatchAnnotation] != "") &&
+	return (event == workloads.WorkloadRollbackInBatch || release.Annotations[v1alpha1.RollbackInBatchAnnotation] != "") &&
 		release.Status.CanaryStatus.NoNeedUpdateReplicas == nil && release.Status.Phase == v1alpha1.RolloutPhaseProgressing
 }
 
@@ -236,5 +236,5 @@ func isRollbackInBatchSatisfied(workloadInfo *util.WorkloadInfo, release *v1alph
 	if workloadInfo.Status == nil {
 		return false
 	}
-	return workloadInfo.Status.StableRevision == workloadInfo.Status.UpdateRevision && release.Annotations[util.RollbackInBatchAnnotation] != ""
+	return workloadInfo.Status.StableRevision == workloadInfo.Status.UpdateRevision && release.Annotations[v1alpha1.RollbackInBatchAnnotation] != ""
 }

pkg/controller/batchrelease/workloads/cloneset_control_plane.go

@@ -66,7 +66,7 @@ func (c *CloneSetRolloutController) VerifyWorkload() (bool, error) {
 // - *int32: how many pods have been patched;
 // - err: whether error occurs.
 func (c *CloneSetRolloutController) prepareBeforeRollback() (bool, *int32, error) {
-	if c.release.Annotations[util.RollbackInBatchAnnotation] != "true" {
+	if c.release.Annotations[v1alpha1.RollbackInBatchAnnotation] != "true" {
 		return true, nil, nil
 	}
 

pkg/controller/batchrelease/workloads/commons.go

@@ -36,7 +36,7 @@ func filterPodsForUnorderedRollback(pods []*corev1.Pod, plannedBatchCanaryReplic
 		if !util.IsConsistentWithRevision(pod, updateRevision) {
 			continue
 		}
-		podRolloutID := pod.Labels[util.RolloutIDLabel]
+		podRolloutID := pod.Labels[v1alpha1.RolloutIDLabel]
 		podRollbackID := pod.Labels[util.NoNeedUpdatePodLabel]
 		if podRollbackID == rolloutID && podRolloutID != rolloutID {
 			noNeedRollbackReplicas++
@@ -122,14 +122,14 @@ func patchPodBatchLabel(c client.Client, pods []*corev1.Pod, rolloutID string, b
 			continue
 		}
 
-		podRolloutID := pod.Labels[util.RolloutIDLabel]
+		podRolloutID := pod.Labels[v1alpha1.RolloutIDLabel]
 		if pod.DeletionTimestamp.IsZero() && podRolloutID == rolloutID {
 			patchedUpdatedReplicas++
 		}
 	}
 
 	for _, pod := range pods {
-		podRolloutID := pod.Labels[util.RolloutIDLabel]
+		podRolloutID := pod.Labels[v1alpha1.RolloutIDLabel]
 		if pod.DeletionTimestamp.IsZero() {
 			// we don't patch label for the active old revision pod
 			if !util.IsConsistentWithRevision(pod, updateRevision) {
@@ -147,7 +147,7 @@ func patchPodBatchLabel(c client.Client, pods []*corev1.Pod, rolloutID string, b
 		}
 
 		podClone := pod.DeepCopy()
-		by := fmt.Sprintf(`{"metadata":{"labels":{"%s":"%s","%s":"%d"}}}`, util.RolloutIDLabel, rolloutID, util.RolloutBatchIDLabel, batchID)
+		by := fmt.Sprintf(`{"metadata":{"labels":{"%s":"%s","%s":"%d"}}}`, v1alpha1.RolloutIDLabel, rolloutID, v1alpha1.RolloutBatchIDLabel, batchID)
 		err := c.Patch(context.TODO(), podClone, client.RawPatch(types.StrategicMergePatchType, []byte(by)))
 		if err != nil {
 			klog.Errorf("Failed to patch Pod(%v) batchID, err: %v", client.ObjectKeyFromObject(pod), err)

pkg/controller/batchrelease/workloads/workload_rollout_control_plane.go

@@ -75,7 +75,7 @@ func (c *UnifiedWorkloadRolloutControlPlane) VerifyWorkload() (bool, error) {
 // - *int32: how many pods have been patched;
 // - err: whether error occurs.
 func (c *UnifiedWorkloadRolloutControlPlane) prepareBeforeRollback() (bool, *int32, error) {
-	if c.release.Annotations[util.RollbackInBatchAnnotation] == "" {
+	if c.release.Annotations[v1alpha1.RollbackInBatchAnnotation] == "" {
 		return true, nil, nil
 	}