Add domain qualified finalizer names and deprecate old (#537)

Fixes GH issue #533

Author: atulv7

api/v1beta1/nutanixcluster_types.go

@@ -34,8 +34,11 @@ const (
 	// NutanixClusterFinalizer allows NutanixClusterReconciler to clean up AHV
 	// resources associated with NutanixCluster before removing it from the
 	// API Server.
-	NutanixClusterFinalizer           = "nutanixcluster.infrastructure.cluster.x-k8s.io"
-	NutanixClusterCredentialFinalizer = "nutanixcluster/infrastructure.cluster.x-k8s.io"
+	NutanixClusterFinalizer           = "infrastructure.cluster.x-k8s.io/nutanixcluster"
+	DeprecatedNutanixClusterFinalizer = "nutanixcluster.infrastructure.cluster.x-k8s.io"
+
+	NutanixClusterCredentialFinalizer           = "infrastructure.cluster.x-k8s.io/nutanixclustercredential"
+	DeprecatedNutanixClusterCredentialFinalizer = "nutanixcluster/infrastructure.cluster.x-k8s.io"
 )
 
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!

api/v1beta1/nutanixmachine_types.go

@@ -34,7 +34,8 @@ const (
 	// NutanixMachineFinalizer allows NutanixMachineReconciler to clean up AHV
 	// resources associated with NutanixMachine before removing it from the
 	// API Server.
-	NutanixMachineFinalizer = "nutanixmachine.infrastructure.cluster.x-k8s.io"
+	NutanixMachineFinalizer           = "infrastructure.cluster.x-k8s.io/nutanixmachine"
+	DeprecatedNutanixMachineFinalizer = "nutanixmachine.infrastructure.cluster.x-k8s.io"
 
 	// NutanixMachineBootstrapRefKindSecret represents the Kind of Secret
 	// referenced by NutanixMachine's BootstrapRef.

controllers/nutanixcluster_controller.go

@@ -280,6 +280,7 @@ func (r *NutanixClusterReconciler) reconcileDelete(rctx *nctx.ClusterContext) (r
 
 	// Remove the finalizer from the NutanixCluster object
 	ctrlutil.RemoveFinalizer(rctx.NutanixCluster, infrav1.NutanixClusterFinalizer)
+	ctrlutil.RemoveFinalizer(rctx.NutanixCluster, infrav1.DeprecatedNutanixClusterFinalizer)
 
 	// Remove the workload cluster client from cache
 	clusterKey := apitypes.NamespacedName{
@@ -303,6 +304,7 @@ func (r *NutanixClusterReconciler) reconcileNormal(rctx *nctx.ClusterContext) (r
 	if !ctrlutil.ContainsFinalizer(rctx.NutanixCluster, infrav1.NutanixClusterFinalizer) {
 		ctrlutil.AddFinalizer(rctx.NutanixCluster, infrav1.NutanixClusterFinalizer)
 	}
+	ctrlutil.RemoveFinalizer(rctx.NutanixCluster, infrav1.DeprecatedNutanixClusterFinalizer)
 
 	// Reconciling failure domains before Ready check to allow failure domains to be modified
 	if err := r.reconcileFailureDomains(rctx); err != nil {
@@ -461,7 +463,9 @@ func (r *NutanixClusterReconciler) reconcileCredentialRefDelete(ctx context.Cont
 		}
 		return err
 	}
+
 	ctrlutil.RemoveFinalizer(secret, infrav1.NutanixClusterCredentialFinalizer)
+	ctrlutil.RemoveFinalizer(secret, infrav1.DeprecatedNutanixClusterCredentialFinalizer)
 	log.V(1).Info(fmt.Sprintf("removing finalizers from secret %s in namespace %s for cluster %s", secret.Name, secret.Namespace, nutanixCluster.Name))
 	if err := r.Client.Update(ctx, secret); err != nil {
 		return err
@@ -514,6 +518,7 @@ func (r *NutanixClusterReconciler) reconcileTrustBundleRef(ctx context.Context,
 	if !ctrlutil.ContainsFinalizer(configMap, infrav1.NutanixClusterCredentialFinalizer) {
 		ctrlutil.AddFinalizer(configMap, infrav1.NutanixClusterCredentialFinalizer)
 	}
+	ctrlutil.RemoveFinalizer(configMap, infrav1.DeprecatedNutanixClusterCredentialFinalizer)
 
 	if err := r.Client.Update(ctx, configMap); err != nil {
 		log.Error(err, "error occurred while updating trust bundle configmap", "nutanixCluster", nutanixCluster)
@@ -549,6 +554,7 @@ func (r *NutanixClusterReconciler) reconcileTrustBundleRefDelete(ctx context.Con
 	}
 
 	ctrlutil.RemoveFinalizer(configMap, infrav1.NutanixClusterCredentialFinalizer)
+	ctrlutil.RemoveFinalizer(configMap, infrav1.DeprecatedNutanixClusterCredentialFinalizer)
 	log.V(1).Info(fmt.Sprintf("removing finalizers from configmap %s/%s for cluster %s", configMap.Namespace, configMap.Name, nutanixCluster.Name))
 	if err := r.Client.Update(ctx, configMap); err != nil {
 		return err
@@ -608,6 +614,7 @@ func (r *NutanixClusterReconciler) reconcileCredentialRef(ctx context.Context, n
 	if !ctrlutil.ContainsFinalizer(secret, infrav1.NutanixClusterCredentialFinalizer) {
 		ctrlutil.AddFinalizer(secret, infrav1.NutanixClusterCredentialFinalizer)
 	}
+	ctrlutil.RemoveFinalizer(secret, infrav1.DeprecatedNutanixClusterCredentialFinalizer)
 
 	err = r.Client.Update(ctx, secret)
 	if err != nil {

controllers/nutanixmachine_controller.go

@@ -318,6 +318,7 @@ func (r *NutanixMachineReconciler) reconcileDelete(rctx *nctx.MachineContext) (r
 		log.Info(fmt.Sprintf("VM UUID was not found in spec for VM %s. Skipping delete", vmName))
 		log.Info(fmt.Sprintf("Removing finalizers for VM %s during delete reconciliation", vmName))
 		ctrlutil.RemoveFinalizer(rctx.NutanixMachine, infrav1.NutanixMachineFinalizer)
+		ctrlutil.RemoveFinalizer(rctx.NutanixMachine, infrav1.DeprecatedNutanixMachineFinalizer)
 		return reconcile.Result{}, nil
 	}
 
@@ -333,6 +334,7 @@ func (r *NutanixMachineReconciler) reconcileDelete(rctx *nctx.MachineContext) (r
 		log.Info(fmt.Sprintf("no VM found with UUID %s: assuming it is already deleted; skipping delete", vmUUID))
 		log.Info(fmt.Sprintf("removing finalizers for VM %s during delete reconciliation", vmName))
 		ctrlutil.RemoveFinalizer(rctx.NutanixMachine, infrav1.NutanixMachineFinalizer)
+		ctrlutil.RemoveFinalizer(rctx.NutanixMachine, infrav1.DeprecatedNutanixMachineFinalizer)
 		return reconcile.Result{}, nil
 	}
 
@@ -433,6 +435,7 @@ func (r *NutanixMachineReconciler) reconcileNormal(rctx *nctx.MachineContext) (r
 	if !ctrlutil.ContainsFinalizer(rctx.NutanixMachine, infrav1.NutanixMachineFinalizer) {
 		ctrlutil.AddFinalizer(rctx.NutanixMachine, infrav1.NutanixMachineFinalizer)
 	}
+	ctrlutil.RemoveFinalizer(rctx.NutanixMachine, infrav1.DeprecatedNutanixMachineFinalizer)
 
 	log.V(1).Info(fmt.Sprintf("Checking current machine status for machine %s: Status %+v Spec %+v", rctx.NutanixMachine.Name, rctx.NutanixMachine.Status, rctx.NutanixMachine.Spec))
 	if rctx.NutanixMachine.Status.Ready {