Set event actions for all emitted events (#1560)

Define event action constants alongside the existing reasons and pass
them to every Eventf call in schedulers, controllers and poollets.
Also fix a few malformed event messages (missing format arguments).

Signed-off-by: Maximilian Moehl <maximilian@moehl.eu>

Author: maxmoehl

internal/controllers/compute/machine_ephemeralvolume_controller.go

@@ -217,7 +217,7 @@ func (r *MachineEphemeralVolumeReconciler) reconcile(ctx context.Context, log lo
 		r.addArchitectureIfNeeded(log, volume, arch)
 		if err := r.handleCreateVolume(ctx, log, machine, volume); err != nil {
 			if apierrors.IsForbidden(err) {
-				r.Eventf(machine, volume, corev1.EventTypeNormal, events.VolumeNotReady, "Volume %s exceeded quota ", volume.Name)
+				r.Eventf(machine, volume, corev1.EventTypeNormal, events.VolumeNotReady, events.CreatingEphemeralVolume, "Volume %s exceeded quota ", volume.Name)
 			}
 			errs = append(errs, err)
 		}

internal/controllers/compute/machine_scheduler.go

@@ -29,6 +29,7 @@ import (
 
 const (
 	outOfCapacity = "OutOfCapacity"
+	scheduling    = "Scheduling"
 )
 
 type MachineScheduler struct {
@@ -101,7 +102,7 @@ func (s *MachineScheduler) reconcileExists(ctx context.Context, log logr.Logger,
 
 	nodes := s.snapshot.ListNodes()
 	if len(nodes) == 0 {
-		s.Eventf(machine, nil, corev1.EventTypeNormal, outOfCapacity, "No nodes available to schedule %s on", machine.Name)
+		s.Eventf(machine, nil, corev1.EventTypeNormal, outOfCapacity, scheduling, "No nodes available to schedule %s on", machine.Name)
 		return ctrl.Result{}, nil
 	}
 
@@ -128,7 +129,7 @@ func (s *MachineScheduler) reconcileExists(ctx context.Context, log logr.Logger,
 	}
 
 	if len(filteredNodes) == 0 {
-		s.Eventf(machine, nil, corev1.EventTypeNormal, outOfCapacity, "No nodes available after filtering to schedule %s on", machine.Name)
+		s.Eventf(machine, nil, corev1.EventTypeNormal, outOfCapacity, scheduling, "No nodes available after filtering to schedule %s on", machine.Name)
 		return ctrl.Result{}, nil
 	}
 

internal/controllers/ipam/prefixallocationscheduler_controller.go

@@ -23,6 +23,10 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 )
 
+const (
+	scheduling = "Scheduling"
+)
+
 type PrefixAllocationScheduler struct {
 	events.EventRecorder
 	client.Client
@@ -149,7 +153,7 @@ func (s *PrefixAllocationScheduler) reconcile(ctx context.Context, log logr.Logg
 	}
 	if ref == "" {
 		log.V(1).Info("No suitable prefix found")
-		s.Eventf(allocation, nil, corev1.EventTypeNormal, "NoSuitablePrefix", "No suitable prefix for scheduling %s found.", allocation.Name)
+		s.Eventf(allocation, nil, corev1.EventTypeNormal, "NoSuitablePrefix", scheduling, "No suitable prefix for scheduling %s found.", allocation.Name)
 		return ctrl.Result{}, nil
 	}
 

internal/controllers/storage/bucket_scheduler.go

@@ -73,7 +73,7 @@ func (s *BucketScheduler) schedule(ctx context.Context, log logr.Logger, bucket
 	}
 	if len(available) == 0 {
 		log.Info("No bucket pool available for bucket class", "BucketClass", bucket.Spec.BucketClassRef.Name)
-		s.Eventf(bucket, nil, corev1.EventTypeNormal, "CannotSchedule", "No BucketPoolRef found for BucketClass %s", bucket.Spec.BucketClassRef.Name)
+		s.Eventf(bucket, nil, corev1.EventTypeNormal, "CannotSchedule", scheduling, "No BucketPoolRef found for BucketClass %s", bucket.Spec.BucketClassRef.Name)
 		return ctrl.Result{}, nil
 	}
 
@@ -86,7 +86,7 @@ func (s *BucketScheduler) schedule(ctx context.Context, log logr.Logger, bucket
 	}
 	if len(filtered) == 0 {
 		log.Info("No bucket pool tolerated by the bucket", "Tolerations", bucket.Spec.Tolerations)
-		s.Eventf(bucket, nil, corev1.EventTypeNormal, "CannotSchedule", "No BucketPoolRef tolerated by the %s", bucket.Name)
+		s.Eventf(bucket, nil, corev1.EventTypeNormal, "CannotSchedule", scheduling, "No BucketPoolRef tolerated by the %s", bucket.Name)
 		return ctrl.Result{}, nil
 	}
 	available = filtered

internal/controllers/storage/volume_scheduler.go

@@ -29,6 +29,7 @@ import (
 
 const (
 	outOfCapacity = "OutOfCapacity"
+	scheduling    = "Scheduling"
 )
 
 type VolumeScheduler struct {
@@ -142,7 +143,7 @@ func (s *VolumeScheduler) reconcileExists(ctx context.Context, log logr.Logger,
 
 	nodes := s.snapshot.ListNodes()
 	if len(nodes) == 0 {
-		s.Eventf(volume, nil, corev1.EventTypeNormal, outOfCapacity, "No nodes available to schedule %s on", volume.Name)
+		s.Eventf(volume, nil, corev1.EventTypeNormal, outOfCapacity, scheduling, "No nodes available to schedule %s on", volume.Name)
 		return ctrl.Result{}, nil
 	}
 
@@ -165,7 +166,7 @@ func (s *VolumeScheduler) reconcileExists(ctx context.Context, log logr.Logger,
 	}
 
 	if len(filteredNodes) == 0 {
-		s.Eventf(volume, nil, corev1.EventTypeNormal, outOfCapacity, "No nodes available after filtering to schedule %s on", volume.Name)
+		s.Eventf(volume, nil, corev1.EventTypeNormal, outOfCapacity, scheduling, "No nodes available after filtering to schedule %s on", volume.Name)
 		return ctrl.Result{}, nil
 	}
 

poollet/bucketpoollet/controllers/bucket_controller.go

@@ -257,7 +257,7 @@ func (r *BucketReconciler) prepareIRIBucketClass(ctx context.Context, bucket *st
 			return "", false, fmt.Errorf("error getting bucket class %s: %w", bucketClassName, err)
 		}
 
-		r.Eventf(bucket, nil, corev1.EventTypeNormal, bucketpoolletevents.BucketClassNotReady, "Bucket class %s not found", bucketClassName)
+		r.Eventf(bucket, nil, corev1.EventTypeNormal, bucketpoolletevents.BucketClassNotReady, bucketpoolletevents.ResolvingBucketClass, "Bucket class %s not found", bucketClassName)
 		return "", false, nil
 	}
 

poollet/bucketpoollet/controllers/events/events.go

@@ -3,6 +3,12 @@
 
 package events
 
+// Event reasons.
 const (
 	BucketClassNotReady = "BucketClassNotReady"
 )
+
+// Event actions.
+const (
+	ResolvingBucketClass = "ResolvingBucketClass"
+)

poollet/machinepoollet/controllers/events/events.go

@@ -3,9 +3,19 @@
 
 package events
 
+// Event reasons.
 const (
 	MachineClassNotReady     = "MachineClassNotReady"
 	NetworkInterfaceNotReady = "NetworkInterfaceNotReady"
 	VolumeNotReady           = "VolumeNotReady"
 	IgnitionNotReady         = "IgnitionNotReady"
 )
+
+// Event actions.
+const (
+	ResolvingMachineClass     = "ResolvingMachineClass"
+	ResolvingIgnition         = "ResolvingIgnition"
+	AttachingNetworkInterface = "AttachingNetworkInterface"
+	AttachingVolume           = "AttachingVolume"
+	CreatingEphemeralVolume   = "CreatingEphemeralVolume"
+)

poollet/machinepoollet/controllers/machine_controller.go

@@ -710,7 +710,7 @@ func (r *MachineReconciler) prepareIRIMachineClass(ctx context.Context, machine
 			return "", false, fmt.Errorf("error getting machine class: %w", err)
 		}
 
-		r.Eventf(machine, nil, corev1.EventTypeNormal, machinepoolletEvents.MachineClassNotReady, "Machine class %s is not ready: %v", machineClassName, err)
+		r.Eventf(machine, nil, corev1.EventTypeNormal, machinepoolletEvents.MachineClassNotReady, machinepoolletEvents.ResolvingMachineClass, "Machine class %s is not ready: %v", machineClassName, err)
 		return "", false, nil
 	}
 
@@ -744,7 +744,7 @@ func (r *MachineReconciler) prepareIRIIgnitionData(ctx context.Context, machine
 			return nil, false, err
 		}
 
-		r.Eventf(machine, nil, corev1.EventTypeNormal, machinepoolletEvents.IgnitionNotReady, "Ignition not ready: %v", ignitionSecret.GetName(), err)
+		r.Eventf(machine, nil, corev1.EventTypeNormal, machinepoolletEvents.IgnitionNotReady, machinepoolletEvents.ResolvingIgnition, "Ignition %s not ready: %v", ignitionSecret.GetName(), err)
 		return nil, false, nil
 	}
 
@@ -755,7 +755,7 @@ func (r *MachineReconciler) prepareIRIIgnitionData(ctx context.Context, machine
 
 	data, ok := ignitionSecret.Data[ignitionKey]
 	if !ok {
-		r.Eventf(machine, nil, corev1.EventTypeNormal, machinepoolletEvents.IgnitionNotReady, "Ignition has no data at key %s", ignitionKey)
+		r.Eventf(machine, nil, corev1.EventTypeNormal, machinepoolletEvents.IgnitionNotReady, machinepoolletEvents.ResolvingIgnition, "Ignition has no data at key %s", ignitionKey)
 		return nil, false, nil
 	}
 

poollet/machinepoollet/controllers/machine_controller_networkinterface.go

@@ -125,7 +125,7 @@ func (r *MachineReconciler) prepareIRINetworkInterfacesForMachine(
 		expectedNicNames := utilslices.ToSetFunc(machine.Spec.NetworkInterfaces, func(v computev1alpha1.NetworkInterface) string { return v.Name })
 		actualNicNames := utilslices.ToSetFunc(iriNics, (*iri.NetworkInterface).GetName)
 		missingNicNames := sets.List(expectedNicNames.Difference(actualNicNames))
-		r.Eventf(machine, nil, corev1.EventTypeNormal, events.NetworkInterfaceNotReady, "Machine network interfaces are not ready: %s", strings.Join(missingNicNames, ", "))
+		r.Eventf(machine, nil, corev1.EventTypeNormal, events.NetworkInterfaceNotReady, events.AttachingNetworkInterface, "Machine network interfaces are not ready: %s", strings.Join(missingNicNames, ", "))
 		return nil, nil, false, nil
 	}
 
@@ -183,17 +183,17 @@ func (r *MachineReconciler) getNetworkInterfaceIP(
 				return commonv1alpha1.IP{}, false, fmt.Errorf("error getting prefix %s: %w", prefixName, err)
 			}
 
-			r.Eventf(machine, nil, corev1.EventTypeNormal, events.NetworkInterfaceNotReady, "Network interface prefix %s not found", prefixName)
+			r.Eventf(machine, nil, corev1.EventTypeNormal, events.NetworkInterfaceNotReady, events.AttachingNetworkInterface, "Network interface prefix %s not found", prefixName)
 			return commonv1alpha1.IP{}, false, nil
 		}
 
 		if !metav1.IsControlledBy(prefix, nic) {
-			r.Eventf(machine, nil, corev1.EventTypeNormal, events.NetworkInterfaceNotReady, "Network interface prefix %s not controlled by network interface", prefixName, nic.Name)
+			r.Eventf(machine, nil, corev1.EventTypeNormal, events.NetworkInterfaceNotReady, events.AttachingNetworkInterface, "Network interface prefix %s not controlled by network interface %s", prefixName, nic.Name)
 			return commonv1alpha1.IP{}, false, nil
 		}
 
 		if prefix.Status.Phase != ipamv1alpha1.PrefixPhaseAllocated {
-			r.Eventf(machine, nil, corev1.EventTypeNormal, events.NetworkInterfaceNotReady, "Network interface prefix %s is not yet allocated", prefixName)
+			r.Eventf(machine, nil, corev1.EventTypeNormal, events.NetworkInterfaceNotReady, events.AttachingNetworkInterface, "Network interface prefix %s is not yet allocated", prefixName)
 			return commonv1alpha1.IP{}, false, nil
 		}
 
@@ -260,7 +260,7 @@ func (r *MachineReconciler) prepareIRINetworkInterface(
 		if !apierrors.IsNotFound(err) {
 			return nil, false, fmt.Errorf("error getting network %s: %w", networkKey.Name, err)
 		}
-		r.Eventf(machine, nil, corev1.EventTypeNormal, events.NetworkInterfaceNotReady, "Network interface %s network %s not found", nic.Name, networkKey.Name)
+		r.Eventf(machine, nil, corev1.EventTypeNormal, events.NetworkInterfaceNotReady, events.AttachingNetworkInterface, "Network interface %s network %s not found", nic.Name, networkKey.Name)
 		return nil, false, nil
 	}
 	nicLabels, err := r.iriNetworkInterfaceLabels(nic)