[ACM-10272] Added warning logs for deprecated spec field usage (#632)

* Added warning logs for deprecated spec field usage Signed-off-by: Disaiah Bennett <[email protected]> * fixed comment Signed-off-by: Disaiah Bennett <[email protected]> --------- Signed-off-by: Disaiah Bennett <[email protected]>
stolostron · Mar 7, 2024 · 9149799 · 9149799
1 parent 7da3c88
commit 9149799
Showing 1 changed file with 30 additions and 8 deletions.
diff --git a/controllers/backplaneconfig_controller.go b/controllers/backplaneconfig_controller.go
@@ -69,14 +69,15 @@ import (
 
 // MultiClusterEngineReconciler reconciles a MultiClusterEngine object
 type MultiClusterEngineReconciler struct {
-	Client          client.Client
-	UncachedClient  client.Client
-	CacheSpec       CacheSpec
-	Scheme          *runtime.Scheme
-	Images          map[string]string
-	StatusManager   *status.StatusTracker
-	Log             logr.Logger
-	UpgradeableCond utils.Condition
+	Client               client.Client
+	UncachedClient       client.Client
+	CacheSpec            CacheSpec
+	Scheme               *runtime.Scheme
+	Images               map[string]string
+	StatusManager        *status.StatusTracker
+	Log                  logr.Logger
+	UpgradeableCond      utils.Condition
+	DeprecatedSpecFields map[string]bool
 }
 
 const (
@@ -182,6 +183,9 @@ func (r *MultiClusterEngineReconciler) Reconcile(ctx context.Context, req ctrl.R
 	backplaneConfig.Status.Conditions = status.FilterOutConditionWithSubString(backplaneConfig.Status.Conditions,
 		backplanev1.MultiClusterEngineComponentFailure)
 
+	// Check if any deprecated fields are present within the backplaneConfig spec.
+	r.CheckDeprecatedFieldUsage(backplaneConfig)
+
 	// reset status manager
 	r.StatusManager.Reset("")
 	for _, c := range backplaneConfig.Status.Conditions {
@@ -1655,6 +1659,24 @@ func (r *MultiClusterEngineReconciler) StopScheduleOperatorControllerResync() {
 	}
 }
 
+func (r *MultiClusterEngineReconciler) CheckDeprecatedFieldUsage(m *backplanev1.MultiClusterEngine) {
+	deprecatedSpecFields := []struct {
+		name      string
+		isPresent bool
+	}{}
+
+	if r.DeprecatedSpecFields == nil {
+		r.DeprecatedSpecFields = make(map[string]bool)
+	}
+
+	for _, f := range deprecatedSpecFields {
+		if f.isPresent && !r.DeprecatedSpecFields[f.name] {
+			r.Log.Info(fmt.Sprintf("Warning: %s field usage is deprecated in operator.", f.name))
+			r.DeprecatedSpecFields[f.name] = true
+		}
+	}
+}
+
 func ensureCRD(ctx context.Context, c client.Client, crd *unstructured.Unstructured) error {
 	existingCRD := &unstructured.Unstructured{}
 	existingCRD.SetGroupVersionKind(crd.GroupVersionKind())