Implement paused condition for machine deployment controller

This change updates the machine deployment controller to set the paused condition
based on if the cluster or machine deployment has the paused annotations.

If the machine deployment is paused a different reason is selected:
MachineDeploymentPausedReason

Author: theobarberbany

api/v1beta1/condition_consts.go

@@ -50,6 +50,9 @@ const (
 
 	// AnnotationPausedReason (Severity=Info) documents a CAPI object that is paused due to the paused annotation being present.
 	AnnotationPausedReason = "PausedAnnotationSet"
+
+	// MachineDeploymentPausedReason (Severity=Info) documents a CAPI object that is paused due to the machine deployment being paused.
+	MachineDeploymentPausedReason = "MachineDeploymentPaused"
 )
 
 const (

internal/controllers/machinedeployment/machinedeployment_controller.go

@@ -87,14 +87,14 @@ func (r *Reconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager, opt
 			handler.EnqueueRequestsFromMapFunc(r.MachineSetToDeployments),
 		).
 		WithOptions(options).
-		WithEventFilter(predicates.ResourceNotPausedAndHasFilterLabel(ctrl.LoggerFrom(ctx), r.WatchFilterValue)).
+		WithEventFilter(predicates.ResourceHasFilterLabel(ctrl.LoggerFrom(ctx), r.WatchFilterValue)).
 		Watches(
 			&clusterv1.Cluster{},
 			handler.EnqueueRequestsFromMapFunc(clusterToMachineDeployments),
 			builder.WithPredicates(
 				// TODO: should this wait for Cluster.Status.InfrastructureReady similar to Infra Machine resources?
 				predicates.All(ctrl.LoggerFrom(ctx),
-					predicates.ClusterUnpaused(ctrl.LoggerFrom(ctx)),
+					predicates.ClusterCreateUpdateEvent(ctrl.LoggerFrom(ctx)),
 				),
 			),
 		).Complete(r)
@@ -130,12 +130,6 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (_ ctrl.Re
 		return ctrl.Result{}, err
 	}
 
-	// Return early if the object or Cluster is paused.
-	if annotations.IsPaused(cluster, deployment) {
-		log.Info("Reconciliation is paused for this object")
-		return ctrl.Result{}, nil
-	}
-
 	// Initialize the patch helper
 	patchHelper, err := patch.NewHelper(deployment, r.Client)
 	if err != nil {
@@ -154,6 +148,29 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (_ ctrl.Re
 		}
 	}()
 
+	// Return early and set the paused condition to True if the object or Cluster
+	// is paused.
+	if annotations.IsPaused(cluster, deployment) {
+		log.Info("Reconciliation is paused for this object")
+
+		newPausedCondition := &clusterv1.Condition{
+			Type:     clusterv1.PausedCondition,
+			Status:   corev1.ConditionTrue,
+			Severity: clusterv1.ConditionSeverityInfo,
+		}
+
+		if cluster.Spec.Paused {
+			newPausedCondition.Reason = clusterv1.ClusterPausedReason
+		} else {
+			newPausedCondition.Reason = clusterv1.AnnotationPausedReason
+		}
+
+		conditions.Set(deployment, newPausedCondition)
+		return ctrl.Result{}, nil
+	}
+
+	conditions.MarkFalseWithNegativePolarity(deployment, clusterv1.PausedCondition)
+
 	// Ignore deleted MachineDeployments, this can happen when foregroundDeletion
 	// is enabled
 	if !deployment.DeletionTimestamp.IsZero() {
@@ -261,6 +278,15 @@ func (r *Reconciler) reconcile(ctx context.Context, cluster *clusterv1.Cluster,
 	}
 
 	if md.Spec.Paused {
+		log.Info("This machine deployment is paused. Sync and status updates will still be reconciled")
+		newPausedCondition := &clusterv1.Condition{
+			Type:     clusterv1.PausedCondition,
+			Status:   corev1.ConditionTrue,
+			Severity: clusterv1.ConditionSeverityInfo,
+			Reason:   clusterv1.MachineDeploymentPausedReason,
+		}
+
+		conditions.Set(md, newPausedCondition)
 		return r.sync(ctx, md, msList)
 	}
 

internal/controllers/machinedeployment/machinedeployment_controller_test.go

@@ -465,6 +465,25 @@ func TestMachineDeploymentReconciler(t *testing.T) {
 			return conditions.IsTrue(deployment, clusterv1.MachineDeploymentAvailableCondition)
 		}, timeout).Should(BeTrue())
 
+		// By default, the machine deployment is not paused
+
+		g.Eventually(func() bool {
+			key := client.ObjectKey{Name: deployment.Name, Namespace: deployment.Namespace}
+			g.Expect(env.Get(ctx, key, deployment)).To(Succeed())
+			return conditions.IsFalse(deployment, clusterv1.PausedCondition)
+		}, timeout).Should(BeTrue())
+
+		// Pause the cluster, expect the paused condition to be set
+		g.Expect(env.Get(ctx, util.ObjectKey(testCluster), testCluster)).To(Succeed())
+		testCluster.Spec.Paused = true
+		g.Expect(env.Update(ctx, testCluster)).To(Succeed())
+
+		g.Eventually(func() bool {
+			key := client.ObjectKey{Name: deployment.Name, Namespace: deployment.Namespace}
+			g.Expect(env.Get(ctx, key, deployment)).To(Succeed())
+			return conditions.IsTrue(deployment, clusterv1.PausedCondition)
+		}, timeout).Should(BeTrue())
+
 		// Validate that the controller set the cluster name label in selector.
 		g.Expect(deployment.Status.Selector).To(ContainSubstring(testCluster.Name))
 	})