Merge pull request #7786 from mtougeron/emit-events-on-status-conditions

✨ Emit Kubernetes Events when Cluster Phase, ControlPlaneReady, or InfrastructureReady change

Author: k8s-ci-robot

internal/controllers/cluster/cluster_controller.go

@@ -24,6 +24,7 @@ import (
 	"time"
 
 	"github.com/pkg/errors"
+	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -331,6 +332,7 @@ func (r *Reconciler) reconcileDelete(ctx context.Context, cluster *clusterv1.Clu
 	}
 
 	controllerutil.RemoveFinalizer(cluster, clusterv1.ClusterFinalizer)
+	r.recorder.Eventf(cluster, corev1.EventTypeNormal, "Deleted", "Cluster %s has been deleted", cluster.Name)
 	return ctrl.Result{}, nil
 }
 

internal/controllers/cluster/cluster_controller_phases.go

@@ -42,6 +42,8 @@ import (
 )
 
 func (r *Reconciler) reconcilePhase(_ context.Context, cluster *clusterv1.Cluster) {
+	preReconcilePhase := cluster.Status.GetTypedPhase()
+
 	if cluster.Status.Phase == "" {
 		cluster.Status.SetTypedPhase(clusterv1.ClusterPhasePending)
 	}
@@ -61,6 +63,16 @@ func (r *Reconciler) reconcilePhase(_ context.Context, cluster *clusterv1.Cluste
 	if !cluster.DeletionTimestamp.IsZero() {
 		cluster.Status.SetTypedPhase(clusterv1.ClusterPhaseDeleting)
 	}
+
+	// Only record the event if the status has changed
+	if preReconcilePhase != cluster.Status.GetTypedPhase() {
+		// Failed clusters should get a Warning event
+		if cluster.Status.GetTypedPhase() == clusterv1.ClusterPhaseFailed {
+			r.recorder.Eventf(cluster, corev1.EventTypeWarning, string(cluster.Status.GetTypedPhase()), "Cluster %s is %s: %s", cluster.Name, string(cluster.Status.GetTypedPhase()), pointer.StringDeref(cluster.Status.FailureMessage, "unknown"))
+		} else {
+			r.recorder.Eventf(cluster, corev1.EventTypeNormal, string(cluster.Status.GetTypedPhase()), "Cluster %s is %s", cluster.Name, string(cluster.Status.GetTypedPhase()))
+		}
+	}
 }
 
 // reconcileExternal handles generic unstructured objects referenced by a Cluster.
@@ -163,11 +175,16 @@ func (r *Reconciler) reconcileInfrastructure(ctx context.Context, cluster *clust
 	}
 
 	// Determine if the infrastructure provider is ready.
+	preReconcileInfrastructureReady := cluster.Status.InfrastructureReady
 	ready, err := external.IsReady(infraConfig)
 	if err != nil {
 		return ctrl.Result{}, err
 	}
 	cluster.Status.InfrastructureReady = ready
+	// Only record the event if the status has changed
+	if preReconcileInfrastructureReady != cluster.Status.InfrastructureReady {
+		r.recorder.Eventf(cluster, corev1.EventTypeNormal, "InfrastructureReady", "Cluster %s InfrastructureReady is now %t", cluster.Name, cluster.Status.InfrastructureReady)
+	}
 
 	// Report a summary of current status of the infrastructure object defined for this cluster.
 	conditions.SetMirror(cluster, clusterv1.InfrastructureReadyCondition,
@@ -225,12 +242,17 @@ func (r *Reconciler) reconcileControlPlane(ctx context.Context, cluster *cluster
 		return ctrl.Result{}, nil
 	}
 
+	preReconcileControlPlaneReady := cluster.Status.ControlPlaneReady
 	// Determine if the control plane provider is ready.
 	ready, err := external.IsReady(controlPlaneConfig)
 	if err != nil {
 		return ctrl.Result{}, err
 	}
 	cluster.Status.ControlPlaneReady = ready
+	// Only record the event if the status has changed
+	if preReconcileControlPlaneReady != cluster.Status.ControlPlaneReady {
+		r.recorder.Eventf(cluster, corev1.EventTypeNormal, "ControlPlaneReady", "Cluster %s ControlPlaneReady is now %t", cluster.Name, cluster.Status.ControlPlaneReady)
+	}
 
 	// Report a summary of current status of the control plane object defined for this cluster.
 	conditions.SetMirror(cluster, clusterv1.ControlPlaneReadyCondition,

internal/controllers/cluster/cluster_controller_phases_test.go

@@ -24,6 +24,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/client-go/tools/record"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
@@ -136,7 +137,8 @@ func TestClusterReconcilePhases(t *testing.T) {
 						Build()
 				}
 				r := &Reconciler{
-					Client: c,
+					Client:   c,
+					recorder: record.NewFakeRecorder(32),
 				}
 
 				res, err := r.reconcileInfrastructure(ctx, tt.cluster)
@@ -215,7 +217,8 @@ func TestClusterReconcilePhases(t *testing.T) {
 						Build()
 				}
 				r := &Reconciler{
-					Client: c,
+					Client:   c,
+					recorder: record.NewFakeRecorder(32),
 				}
 				res, err := r.reconcileKubeconfig(ctx, tt.cluster)
 				if tt.wantErr {
@@ -364,7 +367,8 @@ func TestClusterReconciler_reconcilePhase(t *testing.T) {
 				Build()
 
 			r := &Reconciler{
-				Client: c,
+				Client:   c,
+				recorder: record.NewFakeRecorder(32),
 			}
 			r.reconcilePhase(ctx, tt.cluster)
 			g.Expect(tt.cluster.Status.GetTypedPhase()).To(Equal(tt.wantPhase))
@@ -479,7 +483,8 @@ func TestClusterReconcilePhases_reconcileFailureDomains(t *testing.T) {
 			}
 
 			r := &Reconciler{
-				Client: fake.NewClientBuilder().WithObjects(objs...).Build(),
+				Client:   fake.NewClientBuilder().WithObjects(objs...).Build(),
+				recorder: record.NewFakeRecorder(32),
 			}
 
 			_, err := r.reconcileInfrastructure(ctx, tt.cluster)