Refactor pausing

manifests/crds/rollout-crd.yaml

@@ -2680,6 +2680,8 @@ spec:
                 - type
                 type: object
               type: array
+            controllerPause:
+              type: boolean
             currentPodHash:
               type: string
             currentStepHash:
@@ -2689,6 +2691,19 @@ spec:
               type: integer
             observedGeneration:
               type: string
+            pauseConditions:
+              items:
+                properties:
+                  reason:
+                    type: string
+                  startTime:
+                    format: date-time
+                    type: string
+                required:
+                - reason
+                - startTime
+                type: object
+              type: array
             pauseStartTime:
               format: date-time
               type: string

manifests/install.yaml

@@ -10354,6 +10354,8 @@ spec:
                 - type
                 type: object
               type: array
+            controllerPause:
+              type: boolean
             currentPodHash:
               type: string
             currentStepHash:
@@ -10363,6 +10365,19 @@ spec:
               type: integer
             observedGeneration:
               type: string
+            pauseConditions:
+              items:
+                properties:
+                  reason:
+                    type: string
+                  startTime:
+                    format: date-time
+                    type: string
+                required:
+                - reason
+                - startTime
+                type: object
+              type: array
             pauseStartTime:
               format: date-time
               type: string

manifests/namespace-install.yaml

@@ -10354,6 +10354,8 @@ spec:
                 - type
                 type: object
               type: array
+            controllerPause:
+              type: boolean
             currentPodHash:
               type: string
             currentStepHash:
@@ -10363,6 +10365,19 @@ spec:
               type: integer
             observedGeneration:
               type: string
+            pauseConditions:
+              items:
+                properties:
+                  reason:
+                    type: string
+                  startTime:
+                    format: date-time
+                    type: string
+                required:
+                - reason
+                - startTime
+                type: object
+              type: array
             pauseStartTime:
               format: date-time
               type: string

pkg/apis/rollouts/v1alpha1/types.go

@@ -254,8 +254,30 @@ type RolloutPause struct {
 	Duration *int32 `json:"duration,omitempty"`
 }
 
+// PauseReason reasons that the rollout can pause
+type PauseReason string
+
+const (
+	// PauseReasonInconclusiveAnalysis pauses rollout when rollout has an inconclusive analysis run
+	PauseReasonInconclusiveAnalysis PauseReason = "InconclusiveAnalysisRun"
+	// PauseReasonCanaryPauseStep pause rollout for canary pause step
+	PauseReasonCanaryPauseStep PauseReason = "CanaryPauseStep"
+	// PauseReasonBlueGreenPause pause rollout before promoting rollout
+	PauseReasonBlueGreenPause PauseReason = "BlueGreenPause"
+)
+
+// PauseCondition the reason for a pause and when it started
+type PauseCondition struct {
+	Reason    PauseReason `json:"reason"`
+	StartTime metav1.Time `json:"startTime"`
+}
+
 // RolloutStatus is the status for a Rollout resource
 type RolloutStatus struct {
+	// PauseConditions indicates why the rollout is currently paused
+	PauseConditions []PauseCondition `json:"pauseConditions,omitempty"`
+	//ControllerPause indicates the controller has paused the rollout
+	ControllerPause bool `json:"controllerPause,omitempty"`
 	// CurrentPodHash the hash of the current pod template
 	// +optional
 	CurrentPodHash string `json:"currentPodHash,omitempty"`

pkg/kubectl-argo-rollouts/cmd/resume/resume.go

@@ -14,6 +14,14 @@ const (
   # Resume a rollout
   %[1]s resume guestbook
 `
+	unpausePatch = `{
+	"spec": {
+		"paused": false
+	},
+	"status: {
+		"pauseConditions": null
+	}
+}`
 )
 
 // NewCmdResume returns a new instance of an `rollouts resume` command
@@ -29,7 +37,7 @@ func NewCmdResume(o *options.ArgoRolloutsOptions) *cobra.Command {
 			}
 			rolloutIf := o.RolloutsClientset().ArgoprojV1alpha1().Rollouts(o.Namespace())
 			for _, name := range args {
-				ro, err := rolloutIf.Patch(name, types.MergePatchType, []byte(`{"spec":{"paused":false}}`))
+				ro, err := rolloutIf.Patch(name, types.MergePatchType, []byte(unpausePatch))
 				if err != nil {
 					return err
 				}

pkg/kubectl-argo-rollouts/cmd/resume/resume_test.go

@@ -38,6 +38,12 @@ func TestResumeCmdSuccess(t *testing.T) {
 		Spec: v1alpha1.RolloutSpec{
 			Paused: true,
 		},
+		Status: v1alpha1.RolloutStatus{
+			PauseConditions: []v1alpha1.PauseCondition{{
+				Reason: v1alpha1.PauseReasonCanaryPauseStep,
+			}},
+			ControllerPause: true,
+		},
 	}
 
 	tf, o := options.NewFakeArgoRolloutsOptions(&ro)
@@ -46,7 +52,8 @@ func TestResumeCmdSuccess(t *testing.T) {
 	fakeClient.ReactionChain = nil
 	fakeClient.AddReactor("patch", "*", func(action kubetesting.Action) (handled bool, ret runtime.Object, err error) {
 		if patchAction, ok := action.(kubetesting.PatchAction); ok {
-			if string(patchAction.GetPatch()) == `{"spec":{"paused":false}}` {
+			if string(patchAction.GetPatch()) == unpausePatch {
+				ro.Status.PauseConditions = nil
 				ro.Spec.Paused = false
 			}
 		}
@@ -59,7 +66,9 @@ func TestResumeCmdSuccess(t *testing.T) {
 	err := cmd.Execute()
 	assert.Nil(t, err)
 
+	assert.Nil(t, ro.Status.PauseConditions)
 	assert.False(t, ro.Spec.Paused)
+	assert.True(t, ro.Status.ControllerPause)
 	stdout := o.Out.(*bytes.Buffer).String()
 	stderr := o.ErrOut.(*bytes.Buffer).String()
 	assert.Equal(t, stdout, "rollout 'guestbook' resumed\n")

rollout/analysis.go

@@ -44,7 +44,7 @@ func (c *RolloutController) getAnalysisRunsForRollout(rollout *v1alpha1.Rollout)
 func (c *RolloutController) reconcileAnalysisRuns(roCtx *canaryContext) error {
 	rollout := roCtx.Rollout()
 	otherArs := roCtx.OtherAnalysisRuns()
-	if rollout.Spec.Paused {
+	if len(rollout.Status.PauseConditions) > 0 {
 		return nil
 	}
 	newCurrentAnalysisRuns := []*v1alpha1.AnalysisRun{}
@@ -147,6 +147,10 @@ func (c *RolloutController) reconcileStepBasedAnalysisRun(roCtx *canaryContext)
 		return currentAr, err
 	}
 
+	if currentAr.Status != nil && currentAr.Status.Status == v1alpha1.AnalysisStatusInconclusive {
+		roCtx.PauseContext().AddPauseCondition(v1alpha1.PauseReasonInconclusiveAnalysis)
+	}
+
 	return currentAr, nil
 }
 

rollout/analysis_test.go

@@ -542,20 +542,21 @@ func TestPausedStepAfterInconclusiveAnalysisRun(t *testing.T) {
 	patch := f.getPatchedRollout(patchIndex)
 	now := metav1.Now().UTC().Format(time.RFC3339)
 	expectedPatch := `{
-		"spec":{
-			"paused": true
-		},
 		"status": {
 			"conditions": %s,
 			"canary": {
 				"currentStepAnalysisRun": null
 			},
-			"pauseStartTime": "%s"
+			"pauseConditions": [{
+					"reason": "%s",
+					"startTime": "%s"
+			}],
+			"controllerPause": true
 		}
 	}`
 	condition := generateConditionsPatch(true, conditions.ReplicaSetUpdatedReason, r2, false)
 
-	assert.Equal(t, calculatePatch(r2, fmt.Sprintf(expectedPatch, condition, now)), patch)
+	assert.Equal(t, calculatePatch(r2, fmt.Sprintf(expectedPatch, condition, v1alpha1.PauseReasonInconclusiveAnalysis, now)), patch)
 }
 
 func TestErrorConditionAfterErrorAnalysisRun(t *testing.T) {