Merge pull request #849 from mayankshah1607/mayank/confirm-traffic-webhook

feat: add webhook for manually approving traffic weight increase

artifacts/flagger/crd.yaml

@@ -940,6 +940,7 @@ spec:
                               - post-rollout
                               - event
                               - rollback
+                              - confirm-traffic-increase
                           url:
                             description: URL address of this webhook
                             type: string

charts/flagger/crds/crd.yaml

@@ -940,6 +940,7 @@ spec:
                               - post-rollout
                               - event
                               - rollback
+                              - confirm-traffic-increase
                           url:
                             description: URL address of this webhook
                             type: string

docs/gitbook/usage/webhooks.md

@@ -16,6 +16,9 @@ There are several types of hooks:
 * **rollout** hooks are executed during the analysis on each iteration before the metric checks.
   If a rollout hook call fails the canary advancement is paused and eventfully rolled back.
 
+* **confirm-traffic-increase** hooks are executed right before the weight on the canary is increased. The canary
+  advancement is paused until this hook returns HTTP 200.
+
 * **confirm-promotion** hooks are executed before the promotion step.
   The canary promotion is paused until the hooks return HTTP 200.
   While the promotion is paused, Flagger will continue to run the metrics checks and rollout hooks.
@@ -51,6 +54,9 @@ Spec:
         timeout: 15s
         metadata:
           cmd: "hey -z 1m -q 5 -c 2 http://podinfo-canary.test:9898/"
+      - name: "traffic increase gate"
+        type: confirm-traffic-increase
+        url: http://flagger-loadtester.test/gate/approve
       - name: "promotion gate"
         type: confirm-promotion
         url: http://flagger-loadtester.test/gate/approve
@@ -347,7 +353,8 @@ the web-hook will try to call Concord before timing out (Default is 30s).
 ## Manual Gating
 
 For manual approval of a canary deployment you can use the `confirm-rollout` and `confirm-promotion` webhooks.
-The confirmation rollout hooks are executed before the pre-rollout hooks.
+The confirmation rollout hooks are executed before the pre-rollout hooks. For manually approving traffic weight increase,
+you can use the `confirm-traffic-increase` webhook.
 Flagger will halt the canary traffic shifting and analysis until the confirm webhook returns HTTP status 200.
 
 For manual rollback of a canary deployment you can use the `rollback` webhook.

pkg/apis/flagger/v1beta1/canary.go

@@ -314,6 +314,8 @@ const (
 	EventHook HookType = "event"
 	// RollbackHook rollback canary analysis if webhook returns HTTP 200
 	RollbackHook HookType = "rollback"
+	// ConfirmTrafficIncreaseHook increases traffic weight if webhook returns HTTP 200
+	ConfirmTrafficIncreaseHook = "confirm-traffic-increase"
 )
 
 // CanaryWebhook holds the reference to external checks used for canary analysis

pkg/controller/scheduler.go

@@ -412,6 +412,12 @@ func (c *Controller) advanceCanary(name string, namespace string) {
 
 	// strategy: Canary progressive traffic increase
 	if c.nextStepWeight(cd, canaryWeight) > 0 {
+		// run hook only if traffic is not mirrored
+		if !mirrored {
+			if promote := c.runConfirmTrafficIncreaseHooks(cd); !promote {
+				return
+			}
+		}
 		c.runCanary(cd, canaryController, meshRouter, mirrored, canaryWeight, primaryWeight, maxWeight)
 	}
 

pkg/controller/scheduler_hooks.go

@@ -23,6 +23,22 @@ import (
 	"github.com/fluxcd/flagger/pkg/canary"
 )
 
+func (c *Controller) runConfirmTrafficIncreaseHooks(canary *flaggerv1.Canary) bool {
+	for _, webhook := range canary.GetAnalysis().Webhooks {
+		if webhook.Type == flaggerv1.ConfirmTrafficIncreaseHook {
+			err := CallWebhook(canary.Name, canary.Namespace, flaggerv1.CanaryPhaseProgressing, webhook)
+			if err != nil {
+				c.recordEventWarningf(canary, "Halt %s.%s advancement waiting for traffic increase approval %s",
+					canary.Name, canary.Namespace, webhook.Name)
+				c.alert(canary, "Canary traffic increase is waiting for approval.", false, flaggerv1.SeverityWarn)
+				return false
+			}
+			c.recordEventInfof(canary, "Confirm-traffic-increase check %s passed", webhook.Name)
+		}
+	}
+	return true
+}
+
 func (c *Controller) runConfirmRolloutHooks(canary *flaggerv1.Canary, canaryController canary.Controller) bool {
 	for _, webhook := range canary.GetAnalysis().Webhooks {
 		if webhook.Type == flaggerv1.ConfirmRolloutHook {