Rewrite rollout controller code

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

.github/workflows/e2e-cloneset-1.19.yaml

@@ -107,4 +107,4 @@ jobs:
               kubectl get pod -n kruise-rollout --no-headers| awk '{print $1}' | xargs kubectl logs -p -n kruise-rollout
               exit 1
           fi
-          exit $retVal
+          exit $retVal

.github/workflows/e2e-cloneset-1.23.yaml

@@ -107,4 +107,4 @@ jobs:
               kubectl get pod -n kruise-rollout --no-headers| awk '{print $1}' | xargs kubectl logs -p -n kruise-rollout
               exit 1
           fi
-          exit $retVal
+          exit $retVal

.github/workflows/e2e-deployment-1.19.yaml

@@ -107,4 +107,4 @@ jobs:
               kubectl get pod -n kruise-rollout --no-headers| awk '{print $1}' | xargs kubectl logs -p -n kruise-rollout
               exit 1
           fi
-          exit $retVal
+          exit $retVal

.github/workflows/e2e-deployment-1.23.yaml

@@ -107,4 +107,4 @@ jobs:
               kubectl get pod -n kruise-rollout --no-headers| awk '{print $1}' | xargs kubectl logs -p -n kruise-rollout
               exit 1
           fi
-          exit $retVal
+          exit $retVal

.github/workflows/e2e-others-1.19.yaml

@@ -107,4 +107,4 @@ jobs:
               kubectl get pod -n kruise-rollout --no-headers| awk '{print $1}' | xargs kubectl logs -p -n kruise-rollout
               exit 1
           fi
-          exit $retVal
+          exit $retVal

.github/workflows/e2e-others-1.23.yaml

@@ -107,4 +107,4 @@ jobs:
               kubectl get pod -n kruise-rollout --no-headers| awk '{print $1}' | xargs kubectl logs -p -n kruise-rollout
               exit 1
           fi
-          exit $retVal
+          exit $retVal

.github/workflows/e2e-statefulset-1.19.yaml

@@ -107,4 +107,4 @@ jobs:
               kubectl get pod -n kruise-rollout --no-headers| awk '{print $1}' | xargs kubectl logs -p -n kruise-rollout
               exit 1
           fi
-          exit $retVal
+          exit $retVal

.github/workflows/e2e-statefulset-1.23.yaml

@@ -107,4 +107,4 @@ jobs:
               kubectl get pod -n kruise-rollout --no-headers| awk '{print $1}' | xargs kubectl logs -p -n kruise-rollout
               exit 1
           fi
-          exit $retVal
+          exit $retVal

Dockerfile

@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM golang:1.16 as builder
+FROM golang:1.18 as builder
 
 WORKDIR /workspace
 

Dockerfile_multiarch

@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM --platform=$BUILDPLATFORM golang:1.16 as builder
+FROM --platform=$BUILDPLATFORM golang:1.18 as builder
 
 WORKDIR /workspace
 

api/v1alpha1/rollout_types.go

@@ -26,6 +26,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
@@ -34,9 +51,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 {
@@ -172,17 +191,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.
@@ -241,11 +255,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
@@ -286,11 +288,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
@@ -319,10 +316,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
@@ -374,11 +374,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

config/webhook/patch_manifests.yaml

@@ -7,4 +7,11 @@ webhooks:
     objectSelector:
       matchExpressions:
         - key: rollouts.kruise.io/workload-type
-          operator: Exists
+          operator: Exists
+  - name: mdeployment.kb.io
+    objectSelector:
+      matchExpressions:
+        - key: control-plane
+          operator: NotIn
+          values:
+            - controller-manager

go.mod

@@ -1,6 +1,6 @@
 module github.com/openkruise/rollouts
 
-go 1.16
+go 1.18
 
 require (
 	github.com/davecgh/go-spew v1.1.1
@@ -23,3 +23,55 @@ require (
 	sigs.k8s.io/gateway-api v0.4.3
 	sigs.k8s.io/yaml v1.2.0
 )
+
+require (
+	cloud.google.com/go v0.81.0 // indirect
+	github.com/Azure/go-autorest v14.2.0+incompatible // indirect
+	github.com/Azure/go-autorest/autorest v0.11.18 // indirect
+	github.com/Azure/go-autorest/autorest/adal v0.9.13 // indirect
+	github.com/Azure/go-autorest/autorest/date v0.3.0 // indirect
+	github.com/Azure/go-autorest/logger v0.2.1 // indirect
+	github.com/Azure/go-autorest/tracing v0.6.0 // indirect
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.1.1 // indirect
+	github.com/form3tech-oss/jwt-go v3.2.3+incompatible // indirect
+	github.com/fsnotify/fsnotify v1.4.9 // indirect
+	github.com/go-logr/logr v0.4.0 // indirect
+	github.com/go-logr/zapr v0.4.0 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/google/go-cmp v0.5.6 // indirect
+	github.com/google/gofuzz v1.1.0 // indirect
+	github.com/google/uuid v1.1.2 // indirect
+	github.com/googleapis/gnostic v0.5.5 // indirect
+	github.com/imdario/mergo v0.3.12 // indirect
+	github.com/json-iterator/go v1.1.11 // indirect
+	github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.1 // indirect
+	github.com/nxadm/tail v1.4.8 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/prometheus/client_golang v1.11.0 // indirect
+	github.com/prometheus/client_model v0.2.0 // indirect
+	github.com/prometheus/common v0.26.0 // indirect
+	github.com/prometheus/procfs v0.6.0 // indirect
+	go.uber.org/atomic v1.7.0 // indirect
+	go.uber.org/multierr v1.6.0 // indirect
+	go.uber.org/zap v1.19.0 // indirect
+	golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83 // indirect
+	golang.org/x/net v0.0.0-20211209124913-491a49abca63 // indirect
+	golang.org/x/oauth2 v0.0.0-20210402161424-2e8d93401602 // indirect
+	golang.org/x/sys v0.0.0-20210817190340-bfb29a6856f2 // indirect
+	golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d // indirect
+	golang.org/x/text v0.3.6 // indirect
+	golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac // indirect
+	gomodules.xyz/jsonpatch/v2 v2.2.0 // indirect
+	google.golang.org/appengine v1.6.7 // indirect
+	google.golang.org/protobuf v1.26.0 // indirect
+	gopkg.in/inf.v0 v0.9.1 // indirect
+	gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
+	k8s.io/kube-openapi v0.0.0-20211109043538-20434351676c // indirect
+	sigs.k8s.io/structured-merge-diff/v4 v4.2.1 // indirect
+)

go.sum

@@ -90,7 +90,6 @@ github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnweb
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/certifi/gocertifi v0.0.0-20191021191039-0944d244cd40/go.mod h1:sGbDF6GwGcLpkNXPUTkMRoywsNa/ol15pxFe6ERfguA=
 github.com/certifi/gocertifi v0.0.0-20200922220541-2c3bb06c6054/go.mod h1:sGbDF6GwGcLpkNXPUTkMRoywsNa/ol15pxFe6ERfguA=
-github.com/cespare/xxhash v1.1.0 h1:a6HrQnmkObjyL+Gs60czilIUGqrzKutQD6XZog3p+ko=
 github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc=
 github.com/cespare/xxhash/v2 v2.1.1 h1:6MnRN8NT7+YBpUIWxHtefFZOKTAPgGjpQSxqLNn0+qY=
 github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
@@ -672,7 +671,6 @@ golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5h
 golang.org/x/sys v0.0.0-20181026203630-95b1ffbd15a5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20190204203706-41f3e6584952/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
@@ -1002,7 +1000,6 @@ k8s.io/component-base v0.22.6/go.mod h1:ngHLefY4J5fq2fApNdbWyj4yh0lvw36do4aAjNN8
 k8s.io/gengo v0.0.0-20200413195148-3a45101e95ac/go.mod h1:ezvh/TsK7cY6rbqRK0oQQ8IAqLxYwwyPxAX1Pzy0ii0=
 k8s.io/gengo v0.0.0-20201203183100-97869a43a9d9/go.mod h1:FiNAH4ZV3gBg2Kwh89tzAEV2be7d5xI0vBa/VySYy3E=
 k8s.io/gengo v0.0.0-20201214224949-b6c5ce23f027/go.mod h1:FiNAH4ZV3gBg2Kwh89tzAEV2be7d5xI0vBa/VySYy3E=
-k8s.io/klog v0.2.0 h1:0ElL0OHzF3N+OhoJTL0uca20SxtYt4X4+bzHeqrB83c=
 k8s.io/klog v0.2.0/go.mod h1:Gq+BEi5rUBO/HRz0bTSXDUcqjScdoY3a9IHpCEIOOfk=
 k8s.io/klog/v2 v2.0.0/go.mod h1:PBfzABfn139FHAV07az/IF9Wp1bkk3vpT2XSJ76fSDE=
 k8s.io/klog/v2 v2.2.0/go.mod h1:Od+F08eJP+W3HUb4pSrPpgp9DGU4GzlpG/TmITuYh/Y=

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

@@ -192,7 +192,7 @@ func isWorkloadRevisionChanged(event control.WorkloadEventType, release *v1alpha
 }
 
 func isWorkloadRollbackInBatch(event control.WorkloadEventType, release *v1alpha1.BatchRelease) bool {
-	return (event == control.WorkloadRollbackInBatch || release.Annotations[util.RollbackInBatchAnnotation] != "") &&
+	return (event == control.WorkloadRollbackInBatch || release.Annotations[v1alpha1.RollbackInBatchAnnotation] != "") &&
 		release.Status.CanaryStatus.NoNeedUpdateReplicas == nil && release.Status.Phase == v1alpha1.RolloutPhaseProgressing
 }
 
@@ -201,7 +201,7 @@ func isWorkloadUnstable(event control.WorkloadEventType, _ *v1alpha1.BatchReleas
 }
 
 func isRollbackInBatchSatisfied(workloadInfo *util.WorkloadInfo, release *v1alpha1.BatchRelease) bool {
-	return workloadInfo.Status.StableRevision == workloadInfo.Status.UpdateRevision && release.Annotations[util.RollbackInBatchAnnotation] != ""
+	return workloadInfo.Status.StableRevision == workloadInfo.Status.UpdateRevision && release.Annotations[v1alpha1.RollbackInBatchAnnotation] != ""
 }
 
 func signalRePrepareRollback(newStatus *v1alpha1.BatchReleaseStatus) {

pkg/controller/batchrelease/context/context.go

@@ -20,6 +20,7 @@ import (
 	"encoding/json"
 	"fmt"
 
+	"github.com/openkruise/rollouts/api/v1alpha1"
 	"github.com/openkruise/rollouts/pkg/util"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/util/intstr"
@@ -99,7 +100,7 @@ func batchLabelSatisfied(pods []*corev1.Pod, rolloutID string, targetCount int32
 		if !pod.DeletionTimestamp.IsZero() {
 			return false
 		}
-		return pod.Labels[util.RolloutIDLabel] == rolloutID
+		return pod.Labels[v1alpha1.RolloutIDLabel] == rolloutID
 	})
 	return patchedCount >= int(targetCount)
 }

pkg/controller/batchrelease/context/context_test.go

@@ -151,11 +151,11 @@ func TestIsBatchReady(t *testing.T) {
 func generatePods(updatedReplicas, noNeedRollbackReplicas int) []*corev1.Pod {
 	podsNoNeed := generatePodsWith(map[string]string{
 		util.NoNeedUpdatePodLabel:           "0x1",
-		util.RolloutIDLabel:                 "1",
+		v1alpha1.RolloutIDLabel:             "1",
 		apps.ControllerRevisionHashLabelKey: "version-1",
 	}, noNeedRollbackReplicas, 0)
 	return append(generatePodsWith(map[string]string{
-		util.RolloutIDLabel:                 "1",
+		v1alpha1.RolloutIDLabel:             "1",
 		apps.ControllerRevisionHashLabelKey: "version-1",
 	}, updatedReplicas-noNeedRollbackReplicas, noNeedRollbackReplicas), podsNoNeed...)
 }

pkg/controller/batchrelease/control/partitionstyle/control_plane.go

@@ -201,7 +201,7 @@ func (rc *realBatchControlPlane) SyncWorkloadInformation() (control.WorkloadEven
 // - err: whether error occurs.
 func (rc *realBatchControlPlane) markNoNeedUpdatePodsIfNeeds() (*int32, error) {
 	// currently, we only support rollback scene, in the future, we may support more scenes.
-	if rc.release.Annotations[util.RollbackInBatchAnnotation] == "" {
+	if rc.release.Annotations[v1alpha1.RollbackInBatchAnnotation] == "" {
 		return nil, nil
 	}
 	// currently, if rollout-id is not set, it is no scene which require patch this label