add warnings about changing the name of the controllers unless we add stale condition fixes

Author: deads2k

pkg/operator/apiserver/controller/apiservice/apiservice_controller.go

@@ -121,7 +121,7 @@ func (c *APIServiceController) updateOperatorStatus(
 	defer func() {
 		status := applyoperatorv1.OperatorStatus().
 			WithConditions(conditionAPIServicesDegraded, conditionAPIServicesAvailable)
-		updateError := c.operatorClient.ApplyOperatorStatus(ctx, factory.ControllerFieldManager(c.controllerInstanceName, "updateOperatorStatus"), status)
+		updateError := c.operatorClient.ApplyOperatorStatus(ctx, c.controllerInstanceName, status)
 		if updateError != nil {
 			// overrides error returned through 'return <ERROR>' statement
 			err = updateError

pkg/operator/apiserver/controller/auditpolicy/auditpolicy_controller.go

@@ -58,7 +58,10 @@ func NewAuditPolicyController(
 		configInformers.Config().V1().APIServers().Informer(),
 		kubeInformersForTargetNamesace.Core().V1().ConfigMaps().Informer(),
 		operatorClient.Informer(),
-	).ToController("auditPolicyController", eventRecorder.WithComponentSuffix("audit-policy-controller"))
+	).ToController(
+		"auditPolicyController", // don't change what is passed here unless you also remove the old FooDegraded condition
+		eventRecorder.WithComponentSuffix("audit-policy-controller"),
+	)
 }
 
 func (c *auditPolicyController) sync(ctx context.Context, syncCtx factory.SyncContext) error {

pkg/operator/apiserver/controller/nsfinalizer/finalizer_controller.go

@@ -53,7 +53,10 @@ func NewFinalizerController(
 	return factory.New().ResyncEvery(time.Minute).WithSync(c.sync).WithInformers(
 		kubeInformersForTargetNamespace.Core().V1().Pods().Informer(),
 		kubeInformersForTargetNamespace.Apps().V1().DaemonSets().Informer(),
-	).ToController(fullname, eventRecorder.WithComponentSuffix("finalizer-controller"))
+	).ToController(
+		fullname, // don't change what is passed here unless you also remove the old FooDegraded condition
+		eventRecorder.WithComponentSuffix("finalizer-controller"),
+	)
 }
 
 func (c finalizerController) sync(ctx context.Context, syncCtx factory.SyncContext) error {

pkg/operator/apiserver/controller/workload/workload.go

@@ -110,7 +110,10 @@ func NewController(name, operatorNamespace, targetNamespace, targetOperandVersio
 
 	return c.WithSync(controllerRef.sync).
 		WithInformers(informers...).
-		ToController(fmt.Sprintf("%sWorkloadController", name), eventRecorder)
+		ToController(
+			fmt.Sprintf("%sWorkloadController", name), // don't change what is passed here unless you also remove the old FooDegraded condition
+			eventRecorder,
+		)
 }
 
 func (c *Controller) sync(ctx context.Context, controllerContext factory.SyncContext) error {

pkg/operator/certrotation/client_cert_rotation_controller.go

@@ -98,7 +98,10 @@ func NewCertRotationController(
 		WithPostStartHooks(
 			c.targetCertRecheckerPostRunHook,
 		).
-		ToController("CertRotationController", recorder.WithComponentSuffix("cert-rotation-controller").WithComponentSuffix(name))
+		ToController(
+			"CertRotationController", // don't change what is passed here unless you also remove the old FooDegraded condition
+			recorder.WithComponentSuffix("cert-rotation-controller").WithComponentSuffix(name),
+		)
 }
 
 func (c CertRotationController) Sync(ctx context.Context, syncCtx factory.SyncContext) error {

pkg/operator/configobserver/config_observer_controller.go

@@ -119,7 +119,14 @@ func NewNestedConfigObserver(
 		degradedConditionType:  degradedConditionPrefix + condition.ConfigObservationDegradedConditionType,
 	}
 
-	return factory.New().ResyncEvery(time.Minute).WithSync(c.sync).WithInformers(append(informers, listersToInformer(listers)...)...).ToController("ConfigObserver", eventRecorder.WithComponentSuffix("config-observer"))
+	return factory.New().
+		ResyncEvery(time.Minute).
+		WithSync(c.sync).
+		WithInformers(append(informers, listersToInformer(listers)...)...).
+		ToController(
+			"ConfigObserver", // don't change what is passed here unless you also remove the old FooDegraded condition
+			eventRecorder.WithComponentSuffix("config-observer"),
+		)
 }
 
 // sync reacts to a change in prereqs by finding information that is required to match another value in the cluster. This

pkg/operator/connectivitycheckcontroller/connectivity_check_controller.go

@@ -78,7 +78,10 @@ func NewConnectivityCheckController(
 	c.Controller = factory.New().
 		WithSync(c.Sync).
 		WithInformers(allTriggers...).
-		ToController("ConnectivityCheckController", recorder.WithComponentSuffix("connectivity-check-controller"))
+		ToController(
+			"ConnectivityCheckController", // don't change what is passed here unless you also remove the old FooDegraded condition
+			recorder.WithComponentSuffix("connectivity-check-controller"),
+		)
 	return c
 }
 

pkg/operator/csi/credentialsrequestcontroller/credentials_request_controller.go

@@ -75,7 +75,7 @@ func NewCredentialsRequestController(
 	).WithSyncDegradedOnError(
 		operatorClient,
 	).ToController(
-		c.name,
+		c.name, // don't change what is passed here unless you also remove the old FooDegraded condition
 		recorder.WithComponentSuffix("credentials-request-controller-"+strings.ToLower(name)),
 	)
 }

pkg/operator/csi/csidrivernodeservicecontroller/csi_driver_node_service_controller.go

@@ -71,11 +71,14 @@ type DaemonSetHookFunc func(*opv1.OperatorSpec, *appsv1.DaemonSet) error
 // <name>Progressing: indicates that the CSI Node Service is being deployed.
 // <name>Degraded: produced when the sync() method returns an error.
 type CSIDriverNodeServiceController struct {
-	name           string
-	manifest       []byte
-	operatorClient v1helpers.OperatorClientWithFinalizers
-	kubeClient     kubernetes.Interface
-	dsInformer     appsinformersv1.DaemonSetInformer
+	// instanceName is the name to identify what instance this belongs too: FooDriver for instance
+	instanceName string
+	// controllerInstanceName is the name to identify this instance of this particular control loop: FooDriver-CSIDriverNodeService for instance.
+	controllerInstanceName string
+	manifest               []byte
+	operatorClient         v1helpers.OperatorClientWithFinalizers
+	kubeClient             kubernetes.Interface
+	dsInformer             appsinformersv1.DaemonSetInformer
 	// Optional hook functions to modify the DaemonSet.
 	// If one of these functions returns an error, the sync
 	// fails indicating the ordinal position of the failed function.
@@ -85,7 +88,7 @@ type CSIDriverNodeServiceController struct {
 }
 
 func NewCSIDriverNodeServiceController(
-	name string,
+	instanceName string,
 	manifest []byte,
 	recorder events.Recorder,
 	operatorClient v1helpers.OperatorClientWithFinalizers,
@@ -95,7 +98,8 @@ func NewCSIDriverNodeServiceController(
 	optionalDaemonSetHooks ...DaemonSetHookFunc,
 ) factory.Controller {
 	c := &CSIDriverNodeServiceController{
-		name:                   name,
+		instanceName:           instanceName,
+		controllerInstanceName: factory.ControllerInstanceName(instanceName, "CSIDriverNodeService"),
 		manifest:               manifest,
 		operatorClient:         operatorClient,
 		kubeClient:             kubeClient,
@@ -115,13 +119,13 @@ func NewCSIDriverNodeServiceController(
 	).WithSyncDegradedOnError(
 		operatorClient,
 	).ToController(
-		c.name,
-		recorder.WithComponentSuffix("csi-driver-node-service_"+strings.ToLower(name)),
+		c.instanceName, // don't change what is passed here unless you also remove the old FooDegraded condition
+		recorder.WithComponentSuffix("csi-driver-node-service_"+strings.ToLower(instanceName)),
 	)
 }
 
 func (c *CSIDriverNodeServiceController) Name() string {
-	return c.name
+	return c.instanceName
 }
 
 func (c *CSIDriverNodeServiceController) sync(ctx context.Context, syncContext factory.SyncContext) error {
@@ -154,7 +158,7 @@ func (c *CSIDriverNodeServiceController) sync(ctx context.Context, syncContext f
 func (c *CSIDriverNodeServiceController) syncManaged(ctx context.Context, opSpec *opv1.OperatorSpec, opStatus *opv1.OperatorStatus, syncContext factory.SyncContext) error {
 	klog.V(4).Infof("syncManaged")
 	if management.IsOperatorRemovable() {
-		if err := v1helpers.EnsureFinalizer(ctx, c.operatorClient, c.name); err != nil {
+		if err := v1helpers.EnsureFinalizer(ctx, c.operatorClient, c.instanceName); err != nil {
 			return err
 		}
 	}
@@ -187,7 +191,7 @@ func (c *CSIDriverNodeServiceController) syncManaged(ctx context.Context, opSpec
 
 	// Set Available condition
 	availableCondition := applyoperatorv1.OperatorCondition().
-		WithType(c.name + opv1.OperatorStatusTypeAvailable).
+		WithType(c.instanceName + opv1.OperatorStatusTypeAvailable).
 		WithStatus(opv1.ConditionTrue)
 
 	if daemonSet.Status.NumberAvailable > 0 {
@@ -202,7 +206,7 @@ func (c *CSIDriverNodeServiceController) syncManaged(ctx context.Context, opSpec
 
 	// Set Progressing condition
 	progressingCondition := applyoperatorv1.OperatorCondition().
-		WithType(c.name + opv1.OperatorStatusTypeProgressing).
+		WithType(c.instanceName + opv1.OperatorStatusTypeProgressing).
 		WithStatus(opv1.ConditionFalse)
 
 	if ok, msg := isProgressing(opStatus, daemonSet); ok {
@@ -215,7 +219,7 @@ func (c *CSIDriverNodeServiceController) syncManaged(ctx context.Context, opSpec
 
 	return c.operatorClient.ApplyOperatorStatus(
 		ctx,
-		factory.ControllerFieldManager(c.name, "updateOperatorStatus"),
+		c.controllerInstanceName,
 		status,
 	)
 }
@@ -301,5 +305,5 @@ func (c *CSIDriverNodeServiceController) syncDeleting(ctx context.Context, opSpe
 	}
 
 	// All removed, remove the finalizer as the last step
-	return v1helpers.RemoveFinalizer(ctx, c.operatorClient, c.name)
+	return v1helpers.RemoveFinalizer(ctx, c.operatorClient, c.instanceName)
 }

pkg/operator/csi/csistorageclasscontroller/csi_storageclass_controller.go

@@ -96,7 +96,7 @@ func NewCSIStorageClassController(
 		informerFactory.Storage().V1().StorageClasses().Informer(),
 		operatorInformer.Operator().V1().ClusterCSIDrivers().Informer(),
 	).ToController(
-		"StorageClassController",
+		"StorageClassController", // don't change what is passed here unless you also remove the old FooDegraded condition
 		eventRecorder,
 	)
 }