add DisableGenerateCanaryService for CanaryStrategy

Signed-off-by: yunbo <[email protected]>
openkruise · Mar 6, 2024 · fe7e05d · fe7e05d
1 parent 4846b88
commit fe7e05d
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 18 deletions.
diff --git a/api/v1beta1/rollout_types.go b/api/v1beta1/rollout_types.go
@@ -101,6 +101,8 @@ type CanaryStrategy struct {
 	EnableExtraWorkloadForCanary bool `json:"enableExtraWorkloadForCanary,omitempty"`
 	// TrafficRoutingRef is TrafficRouting's Name
 	TrafficRoutingRef string `json:"trafficRoutingRef,omitempty"`
+	// canary service will not be generated if DisableGenerateCanaryService is true
+	DisableGenerateCanaryService bool `json:"disableGenerateCanaryService,omitempty"`
 }
 
 type PatchPodTemplateMetadata struct {

diff --git a/config/crd/bases/rollouts.kruise.io_rollouts.yaml b/config/crd/bases/rollouts.kruise.io_rollouts.yaml
@@ -581,6 +581,10 @@ spec:
                           deployment and release the deployment workload-demo in full.
                           Current only support k8s native deployment'
                         type: boolean
+                      disableGenerateCanaryService:
+                        description: 'If true, the canary Service will not be generated 
+                          during the rollout process. Default to false'
+                        type: boolean
                       failureThreshold:
                         anyOf:
                         - type: integer

diff --git a/pkg/controller/rollout/rollout_progressing.go b/pkg/controller/rollout/rollout_progressing.go
@@ -452,14 +452,15 @@ func newTrafficRoutingContext(c *RolloutContext) *trafficrouting.TrafficRoutingC
 		revisionLabelKey = c.Workload.RevisionLabelKey
 	}
 	return &trafficrouting.TrafficRoutingContext{
-		Key:              fmt.Sprintf("Rollout(%s/%s)", c.Rollout.Namespace, c.Rollout.Name),
-		Namespace:        c.Rollout.Namespace,
-		ObjectRef:        c.Rollout.Spec.Strategy.Canary.TrafficRoutings,
-		Strategy:         currentStep.TrafficRoutingStrategy,
-		OwnerRef:         *metav1.NewControllerRef(c.Rollout, rolloutControllerKind),
-		RevisionLabelKey: revisionLabelKey,
-		StableRevision:   c.NewStatus.CanaryStatus.StableRevision,
-		CanaryRevision:   c.NewStatus.CanaryStatus.PodTemplateHash,
-		LastUpdateTime:   c.NewStatus.CanaryStatus.LastUpdateTime,
+		Key:                          fmt.Sprintf("Rollout(%s/%s)", c.Rollout.Namespace, c.Rollout.Name),
+		Namespace:                    c.Rollout.Namespace,
+		ObjectRef:                    c.Rollout.Spec.Strategy.Canary.TrafficRoutings,
+		Strategy:                     currentStep.TrafficRoutingStrategy,
+		OwnerRef:                     *metav1.NewControllerRef(c.Rollout, rolloutControllerKind),
+		RevisionLabelKey:             revisionLabelKey,
+		StableRevision:               c.NewStatus.CanaryStatus.StableRevision,
+		CanaryRevision:               c.NewStatus.CanaryStatus.PodTemplateHash,
+		LastUpdateTime:               c.NewStatus.CanaryStatus.LastUpdateTime,
+		DisableGenerateCanaryService: c.Rollout.Spec.Strategy.Canary.DisableGenerateCanaryService,
 	}
 }
diff --git a/pkg/trafficrouting/manager.go b/pkg/trafficrouting/manager.go
@@ -57,6 +57,8 @@ type TrafficRoutingContext struct {
 	CanaryRevision string
 	// newStatus.canaryStatus.LastUpdateTime
 	LastUpdateTime *metav1.Time
+	// won't work for Ingress and Gateway
+	DisableGenerateCanaryService bool
 }
 
 // Manager responsible for adjusting network resources
@@ -82,7 +84,7 @@ func (m *Manager) InitializeTrafficRouting(c *TrafficRoutingContext) error {
 	if err := m.Get(context.TODO(), types.NamespacedName{Namespace: c.Namespace, Name: sService}, service); err != nil {
 		return err
 	}
-	cService := getCanaryServiceName(sService, c.OnlyTrafficRouting)
+	cService := getCanaryServiceName(sService, c.OnlyTrafficRouting, c.DisableGenerateCanaryService)
 	// new network provider, ingress or gateway
 	trController, err := newNetworkProvider(m.Client, c, sService, cService)
 	if err != nil {
@@ -116,7 +118,7 @@ func (m *Manager) DoTrafficRouting(c *TrafficRoutingContext) (bool, error) {
 		return false, err
 	}
 	// canary service name
-	canaryServiceName := getCanaryServiceName(trafficRouting.Service, c.OnlyTrafficRouting)
+	canaryServiceName := getCanaryServiceName(trafficRouting.Service, c.OnlyTrafficRouting, c.DisableGenerateCanaryService)
 	canaryService := &corev1.Service{}
 	canaryService.Namespace = stableService.Namespace
 	canaryService.Name = canaryServiceName
@@ -131,7 +133,7 @@ func (m *Manager) DoTrafficRouting(c *TrafficRoutingContext) (bool, error) {
 
 	// end-to-end canary deployment scenario(a -> b -> c), if only b or c is released,
 	//and a is not released in this scenario, then the canary service is not needed.
-	if !c.OnlyTrafficRouting {
+	if !c.OnlyTrafficRouting && !c.DisableGenerateCanaryService {
 		if c.StableRevision == "" || c.CanaryRevision == "" {
 			klog.Warningf("%s stableRevision or podTemplateHash can not be empty, and wait a moment", c.Key)
 			return false, nil
@@ -206,7 +208,7 @@ func (m *Manager) FinalisingTrafficRouting(c *TrafficRoutingContext, onlyRestore
 		trafficRouting.GracePeriodSeconds = defaultGracePeriodSeconds
 	}
 
-	cServiceName := getCanaryServiceName(trafficRouting.Service, c.OnlyTrafficRouting)
+	cServiceName := getCanaryServiceName(trafficRouting.Service, c.OnlyTrafficRouting, c.DisableGenerateCanaryService)
 	trController, err := newNetworkProvider(m.Client, c, trafficRouting.Service, cServiceName)
 	if err != nil {
 		klog.Errorf("%s newTrafficRoutingController failed: %s", c.Key, err.Error())
@@ -215,6 +217,7 @@ func (m *Manager) FinalisingTrafficRouting(c *TrafficRoutingContext, onlyRestore
 
 	cService := &corev1.Service{ObjectMeta: metav1.ObjectMeta{Namespace: c.Namespace, Name: cServiceName}}
 	// if canary svc has been already cleaned up, just return
+	// even DisableGenerateCanaryService is true, canary svc still exists, because canary service is stable service
 	if err = m.Get(context.TODO(), client.ObjectKeyFromObject(cService), cService); err != nil {
 		if !errors.IsNotFound(err) {
 			klog.Errorf("%s get canary service(%s) failed: %s", c.Key, cServiceName, err.Error())
@@ -259,7 +262,7 @@ func (m *Manager) FinalisingTrafficRouting(c *TrafficRoutingContext, onlyRestore
 	}
 	// end to end deployment, don't remove the canary service;
 	// because canary service is stable service
-	if !c.OnlyTrafficRouting {
+	if !c.OnlyTrafficRouting && !c.DisableGenerateCanaryService {
 		// remove canary service
 		err = m.Delete(context.TODO(), cService)
 		if err != nil && !errors.IsNotFound(err) {
@@ -281,6 +284,8 @@ func newNetworkProvider(c client.Client, con *TrafficRoutingContext, sService, c
 			StableService: sService,
 			TrafficConf:   trafficRouting.CustomNetworkRefs,
 			OwnerRef:      con.OwnerRef,
+			//only set for CustomController, never work for Ingress and Gateway
+			DisableGenerateCanaryService: con.DisableGenerateCanaryService,
 		})
 	}
 	if trafficRouting.Ingress != nil {
@@ -375,8 +380,8 @@ func (m *Manager) restoreStableService(c *TrafficRoutingContext) (bool, error) {
 	return true, nil
 }
 
-func getCanaryServiceName(sService string, onlyTrafficRouting bool) string {
-	if onlyTrafficRouting {
+func getCanaryServiceName(sService string, onlyTrafficRouting bool, disableGenerateCanaryService bool) string {
+	if onlyTrafficRouting || disableGenerateCanaryService {
 		return sService
 	}
 	return fmt.Sprintf("%s-canary", sService)

diff --git a/pkg/trafficrouting/network/customNetworkProvider/custom_network_provider.go b/pkg/trafficrouting/network/customNetworkProvider/custom_network_provider.go
@@ -72,8 +72,9 @@ type Config struct {
 	CanaryService string
 	StableService string
 	// network providers need to be created
-	TrafficConf []v1beta1.ObjectRef
-	OwnerRef    metav1.OwnerReference
+	TrafficConf                  []v1beta1.ObjectRef
+	OwnerRef                     metav1.OwnerReference
+	DisableGenerateCanaryService bool
 }
 
 func NewCustomController(client client.Client, conf Config) (network.NetworkProvider, error) {