chore: unify finalizers

api/cloud-control/v1beta1/types.go

@@ -9,7 +9,3 @@ const (
 	StateWarning    StatusState = "Warning"
 	StateDeleting   StatusState = "Deleting"
 )
-
-const (
-	FinalizerName = "cloud-control.kyma-project.io/deletion-hook"
-)

api/finalizer.go

@@ -0,0 +1,12 @@
+package api
+
+const (
+	CommonFinalizerDeletionHook = "cloud-manager.kyma-project.io/deletion-hook"
+)
+
+// TODO: Remove in next release - after 1.2.5 is released, aka in the 1.2.6
+// Finalizer migration
+const (
+	DO_NOT_USE_OLD_KcpFinalizer = "cloud-control.kyma-project.io/deletion-hook"
+	DO_NOT_USE_OLD_SkrFinalizer = "cloud-resources.kyma-project.io/deletion-hook"
+)

cmd/main.go

@@ -22,6 +22,7 @@ import (
 
 	cceeconfig "github.com/kyma-project/cloud-manager/pkg/kcp/provider/ccee/config"
 	cceenfsinstanceclient "github.com/kyma-project/cloud-manager/pkg/kcp/provider/ccee/nfsinstance/client"
+	"github.com/kyma-project/cloud-manager/pkg/migrateFinalizers"
 
 	"github.com/fsnotify/fsnotify"
 
@@ -366,11 +367,21 @@ func main() {
 		}
 	}()
 
+	// TODO: Remove in next release - after 1.2.5 is released, aka in the 1.2.6
+	// Finalizer migration
+	func() {
+		migLogger := setupLog.WithName("kcpFinalizerMigration")
+		mig := migrateFinalizers.NewMigrationForKcp(mgr.GetAPIReader(), mgr.GetClient(), migLogger)
+		_, err := mig.Run(ctx)
+		if err != nil {
+			migLogger.Error(err, "error running KCP finalizer migration")
+		}
+	}()
+
 	if err := mgr.Start(ctx); err != nil {
 		setupLog.Error(err, "problem running manager")
 		os.Exit(1)
 	}
-	// 2024-03-04T14:18
 }
 
 func loadConfig() config.Config {

internal/api-tests/suite_test.go

@@ -29,7 +29,6 @@ import (
 
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
-	//+kubebuilder:scaffold:imports
 )
 
 // These tests use Ginkgo (BDD-style Go testing framework). Refer to

internal/controller/cloud-control/iprange_azure_test.go

@@ -2,6 +2,7 @@ package cloudcontrol
 
 import (
 	"fmt"
+	"github.com/kyma-project/cloud-manager/api"
 
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/privatedns/armprivatedns"
@@ -112,7 +113,7 @@ var _ = Describe("Feature: KCP IpRange for Azure", func() {
 			Eventually(LoadAndCheck).
 				WithArguments(infra.Ctx(), infra.KCP().Client(), kcpNetworkCm, NewObjActions()).
 				Should(Succeed())
-			added, err := composed.PatchObjAddFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, kcpNetworkCm, infra.KCP().Client())
+			added, err := composed.PatchObjAddFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, kcpNetworkCm, infra.KCP().Client())
 			Expect(added).To(BeTrue())
 			Expect(err).NotTo(HaveOccurred())
 		})
@@ -156,7 +157,7 @@ var _ = Describe("Feature: KCP IpRange for Azure", func() {
 			Eventually(LoadAndCheck).
 				WithArguments(infra.Ctx(), infra.KCP().Client(), kcpVpcPeering, NewObjActions()).
 				Should(Succeed())
-			added, err := composed.PatchObjAddFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, kcpVpcPeering, infra.KCP().Client())
+			added, err := composed.PatchObjAddFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, kcpVpcPeering, infra.KCP().Client())
 			Expect(added).To(BeTrue())
 			Expect(err).NotTo(HaveOccurred())
 		})
@@ -288,7 +289,7 @@ var _ = Describe("Feature: KCP IpRange for Azure", func() {
 		})
 
 		By("When KCP VpcPeering finalizer is removed", func() {
-			removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, kcpVpcPeering, infra.KCP().Client())
+			removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, kcpVpcPeering, infra.KCP().Client())
 			Expect(removed).To(BeTrue())
 			Expect(err).NotTo(HaveOccurred())
 		})
@@ -307,7 +308,7 @@ var _ = Describe("Feature: KCP IpRange for Azure", func() {
 		})
 
 		By("When KCP CM Network finalizer is removed", func() {
-			removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, kcpNetworkCm, infra.KCP().Client())
+			removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, kcpNetworkCm, infra.KCP().Client())
 			Expect(removed).To(BeTrue())
 			Expect(err).NotTo(HaveOccurred())
 		})

internal/controller/cloud-control/network_azure_test.go

@@ -3,6 +3,7 @@ package cloudcontrol
 import (
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
+	"github.com/kyma-project/cloud-manager/api"
 	cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
 	"github.com/kyma-project/cloud-manager/pkg/common"
 	azurecommon "github.com/kyma-project/cloud-manager/pkg/kcp/provider/azure/common"
@@ -55,7 +56,7 @@ var _ = Describe("Feature: KCP Azure managed Network", func() {
 		})
 
 		By("And Then KCP Network has finalizer", func() {
-			Expect(controllerutil.ContainsFinalizer(net, cloudcontrolv1beta1.FinalizerName)).To(BeTrue())
+			Expect(controllerutil.ContainsFinalizer(net, api.CommonFinalizerDeletionHook)).To(BeTrue())
 		})
 
 		By("And Then Network status reference is set", func() {

internal/controller/cloud-control/network_reference_test.go

@@ -1,6 +1,7 @@
 package cloudcontrol
 
 import (
+	"github.com/kyma-project/cloud-manager/api"
 	"time"
 
 	cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
@@ -60,7 +61,7 @@ var _ = Describe("Feature: KCP Network reference", func() {
 		})
 
 		By("And Then Network has finalizer", func() {
-			Expect(controllerutil.ContainsFinalizer(net, cloudcontrolv1beta1.FinalizerName)).To(BeTrue())
+			Expect(controllerutil.ContainsFinalizer(net, api.CommonFinalizerDeletionHook)).To(BeTrue())
 		})
 
 		By("When Network is deleted", func() {

internal/controller/cloud-control/nfsinstance_gcp_test.go

@@ -2,6 +2,7 @@ package cloudcontrol
 
 import (
 	"context"
+	"github.com/kyma-project/cloud-manager/api"
 	"time"
 
 	"github.com/kyma-project/cloud-manager/pkg/composed"
@@ -449,7 +450,7 @@ var _ = Describe("Feature: KCP NFSVolume for GCP", func() {
 				WithArguments(infra.Ctx(), infra.KCP().Client(), gcpNfsInstance).
 				Should(Succeed())
 			Eventually(func(ctx context.Context) error {
-				_, err := composed.PatchObjRemoveFinalizer(ctx, cloudcontrolv1beta1.FinalizerName, gcpNfsInstance, infra.KCP().Client())
+				_, err := composed.PatchObjRemoveFinalizer(ctx, api.CommonFinalizerDeletionHook, gcpNfsInstance, infra.KCP().Client())
 				return err
 			}).
 				WithContext(infra.Ctx()).

internal/controller/cloud-control/nuke_controller_test.go

@@ -2,6 +2,7 @@ package cloudcontrol
 
 import (
 	"fmt"
+	"github.com/kyma-project/cloud-manager/api"
 	cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
 	"github.com/kyma-project/cloud-manager/pkg/common"
 	"github.com/kyma-project/cloud-manager/pkg/common/actions/focal"
@@ -43,7 +44,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
 			kcpnetwork.Ignore.AddName(cmNetwork.Name)
 
 			Expect(CreateObj(infra.Ctx(), infra.KCP().Client(), cmNetwork,
-				AddFinalizer(cloudcontrolv1beta1.FinalizerName),
+				AddFinalizer(api.CommonFinalizerDeletionHook),
 			)).To(Succeed(), "failed creating cm network")
 		})
 
@@ -56,7 +57,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
 			Eventually(CreateKcpIpRange).
 				WithArguments(infra.Ctx(), infra.KCP().Client(), ipRange,
 					WithName(ipRangeName),
-					AddFinalizer(cloudcontrolv1beta1.FinalizerName),
+					AddFinalizer(api.CommonFinalizerDeletionHook),
 					WithKcpIpRangeNetwork(cmNetwork.Name),
 					WithScope(kymaName),
 					WithRemoteRef("foo"),
@@ -76,7 +77,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
 			kcpvpcpeering.Ignore.AddName(vpcPeering.Name)
 
 			Expect(CreateObj(infra.Ctx(), infra.KCP().Client(), vpcPeering,
-				AddFinalizer(cloudcontrolv1beta1.FinalizerName),
+				AddFinalizer(api.CommonFinalizerDeletionHook),
 			)).To(Succeed(), "failed creating VpcPeering")
 		})
 
@@ -88,7 +89,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
 
 			Expect(CreateRedisInstance(infra.Ctx(), infra.KCP().Client(), redisInstance,
 				WithName(redisInstanceName),
-				AddFinalizer(cloudcontrolv1beta1.FinalizerName),
+				AddFinalizer(api.CommonFinalizerDeletionHook),
 				WithRemoteRef("remote-redis"),
 				WithIpRange(ipRange.Name),
 				WithScope(kymaName),
@@ -106,12 +107,12 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
 
 			Expect(CreateNfsInstance(infra.Ctx(), infra.KCP().Client(), nfsInstance,
 				WithName(nfsInstanceName),
-				AddFinalizer(cloudcontrolv1beta1.FinalizerName),
+				AddFinalizer(api.CommonFinalizerDeletionHook),
 				WithRemoteRef("foo"),
 				WithScope(kymaName),
 				WithIpRange(ipRange.Name),
 				WithNfsInstanceAws(), // never mind it doesn't match Azure, won't be reconciled anyway
-				AddFinalizer(cloudcontrolv1beta1.FinalizerName),
+				AddFinalizer(api.CommonFinalizerDeletionHook),
 			)).To(Succeed(), "failed creating NfsInstance")
 		})
 
@@ -158,7 +159,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
 
 		for kind, obj := range resources {
 			By(fmt.Sprintf("When resource %s finalizer is removed", kind), func() {
-				removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, obj, infra.KCP().Client())
+				removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, obj, infra.KCP().Client())
 				Expect(err).To(Succeed())
 				Expect(removed).To(BeTrue())
 			})

internal/controller/cloud-control/nuke_gcp_test.go

@@ -3,6 +3,7 @@ package cloudcontrol
 import (
 	"context"
 	"fmt"
+	"github.com/kyma-project/cloud-manager/api"
 	cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
 	"github.com/kyma-project/cloud-manager/pkg/common"
 	"github.com/kyma-project/cloud-manager/pkg/common/actions/focal"
@@ -51,7 +52,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
 			kcpnetwork.Ignore.AddName(cmNetwork.Name)
 
 			Expect(CreateObj(infra.Ctx(), infra.KCP().Client(), cmNetwork,
-				AddFinalizer(cloudcontrolv1beta1.FinalizerName),
+				AddFinalizer(api.CommonFinalizerDeletionHook),
 			)).To(Succeed(), "failed creating cm network")
 		})
 
@@ -64,7 +65,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
 			Eventually(CreateKcpIpRange).
 				WithArguments(infra.Ctx(), infra.KCP().Client(), ipRange,
 					WithName(ipRangeName),
-					AddFinalizer(cloudcontrolv1beta1.FinalizerName),
+					AddFinalizer(api.CommonFinalizerDeletionHook),
 					WithKcpIpRangeNetwork(cmNetwork.Name),
 					WithScope(kymaName),
 					WithRemoteRef("foo"),
@@ -81,12 +82,12 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
 
 			Expect(CreateNfsInstance(infra.Ctx(), infra.KCP().Client(), nfsInstance,
 				WithName(nfsInstanceName),
-				AddFinalizer(cloudcontrolv1beta1.FinalizerName),
+				AddFinalizer(api.CommonFinalizerDeletionHook),
 				WithRemoteRef("foo"),
 				WithScope(kymaName),
 				WithIpRange(ipRange.Name),
 				WithNfsInstanceGcp(scope.Spec.Region),
-				AddFinalizer(cloudcontrolv1beta1.FinalizerName),
+				AddFinalizer(api.CommonFinalizerDeletionHook),
 			)).To(Succeed(), "failed creating NfsInstance")
 		})
 
@@ -169,7 +170,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
 
 		for kind, obj := range resources {
 			By(fmt.Sprintf("When resource %s finalizer is removed", kind), func() {
-				removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, obj, infra.KCP().Client())
+				removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, obj, infra.KCP().Client())
 				Expect(err).To(Succeed())
 				Expect(removed).To(BeTrue())
 			})

internal/controller/cloud-control/scope_aws_test.go

@@ -3,6 +3,7 @@ package cloudcontrol
 import (
 	"fmt"
 	gardenerTypes "github.com/gardener/gardener/pkg/apis/core/v1beta1"
+	"github.com/kyma-project/cloud-manager/api"
 	cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
 	cloudresourcesv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-resources/v1beta1"
 	"github.com/kyma-project/cloud-manager/pkg/common"
@@ -122,7 +123,7 @@ var _ = Describe("Feature: KCP Scope AWS", func() {
 			Eventually(LoadAndCheck).
 				WithArguments(infra.Ctx(), infra.KCP().Client(), kymaCR, NewObjActions()).
 				Should(Succeed())
-			Expect(controllerutil.ContainsFinalizer(kymaCR, cloudcontrolv1beta1.FinalizerName)).
+			Expect(controllerutil.ContainsFinalizer(kymaCR, api.CommonFinalizerDeletionHook)).
 				To(BeTrue(), "expected Kyma CR to have finalizer, but it does not")
 		})
 
@@ -212,7 +213,7 @@ var _ = Describe("Feature: KCP Scope AWS", func() {
 				WithArguments(infra.Ctx(), infra.KCP().Client(), kymaCR, NewObjActions()).
 				Should(Succeed(), "failed reloading Kyma CR")
 
-			Expect(controllerutil.ContainsFinalizer(kymaCR, cloudcontrolv1beta1.FinalizerName)).
+			Expect(controllerutil.ContainsFinalizer(kymaCR, api.CommonFinalizerDeletionHook)).
 				To(BeFalse(), "expected Kyma CR not to have finalizer, but it still has it")
 		})
 

internal/controller/cloud-control/scope_azure_test.go

@@ -3,6 +3,7 @@ package cloudcontrol
 import (
 	"fmt"
 	gardenerTypes "github.com/gardener/gardener/pkg/apis/core/v1beta1"
+	"github.com/kyma-project/cloud-manager/api"
 	cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
 	cloudresourcesv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-resources/v1beta1"
 	"github.com/kyma-project/cloud-manager/pkg/common"
@@ -122,7 +123,7 @@ var _ = Describe("Feature: KCP Scope Azure", func() {
 			Eventually(LoadAndCheck).
 				WithArguments(infra.Ctx(), infra.KCP().Client(), kymaCR, NewObjActions()).
 				Should(Succeed())
-			Expect(controllerutil.ContainsFinalizer(kymaCR, cloudcontrolv1beta1.FinalizerName)).
+			Expect(controllerutil.ContainsFinalizer(kymaCR, api.CommonFinalizerDeletionHook)).
 				To(BeTrue(), "expected Kyma CR to have finalizer, but it does not")
 		})
 
@@ -185,7 +186,7 @@ var _ = Describe("Feature: KCP Scope Azure", func() {
 				WithArguments(infra.Ctx(), infra.KCP().Client(), kymaCR, NewObjActions()).
 				Should(Succeed(), "failed reloading Kyma CR")
 
-			Expect(controllerutil.ContainsFinalizer(kymaCR, cloudcontrolv1beta1.FinalizerName)).
+			Expect(controllerutil.ContainsFinalizer(kymaCR, api.CommonFinalizerDeletionHook)).
 				To(BeFalse(), "expected Kyma CR not to have finalizer, but it still has it")
 		})
 

internal/controller/cloud-control/vpcpeering_aws_test.go

@@ -3,6 +3,7 @@ package cloudcontrol
 import (
 	"errors"
 	"fmt"
+	"github.com/kyma-project/cloud-manager/api"
 
 	ec2Types "github.com/aws/aws-sdk-go-v2/service/ec2/types"
 	cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
@@ -247,7 +248,7 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
 			Eventually(LoadAndCheck).
 				WithArguments(infra.Ctx(), infra.KCP().Client(), kcpPeering,
 					NewObjActions(),
-					HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
+					HaveFinalizer(api.CommonFinalizerDeletionHook),
 					HavingKcpVpcPeeringStatusIdNotEmpty(),
 				).Should(Succeed())
 		})
@@ -519,7 +520,7 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
 			Eventually(LoadAndCheck).
 				WithArguments(infra.Ctx(), infra.KCP().Client(), kcpPeering,
 					NewObjActions(),
-					HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
+					HaveFinalizer(api.CommonFinalizerDeletionHook),
 					HavingKcpVpcPeeringStatusIdNotEmpty(),
 				).Should(Succeed())
 		})
@@ -755,7 +756,7 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
 			Eventually(LoadAndCheck).
 				WithArguments(infra.Ctx(), infra.KCP().Client(), localKcpNet,
 					NewObjActions(),
-					HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
+					HaveFinalizer(api.CommonFinalizerDeletionHook),
 					HavingConditionTrue(cloudcontrolv1beta1.ConditionTypeReady),
 				).Should(Succeed())
 		})
@@ -776,7 +777,7 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
 			Eventually(LoadAndCheck).
 				WithArguments(infra.Ctx(), infra.KCP().Client(), remoteKcpNet,
 					NewObjActions(),
-					HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
+					HaveFinalizer(api.CommonFinalizerDeletionHook),
 					HavingConditionTrue(cloudcontrolv1beta1.ConditionTypeReady),
 				).Should(Succeed())
 		})
@@ -801,7 +802,7 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
 			Eventually(LoadAndCheck).
 				WithArguments(infra.Ctx(), infra.KCP().Client(), kcpPeering,
 					NewObjActions(),
-					HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
+					HaveFinalizer(api.CommonFinalizerDeletionHook),
 					HavingKcpVpcPeeringStatusIdNotEmpty(),
 				).Should(Succeed())
 		})