Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: don't add finalizer for StorageProvider #9022

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: don't add finalizer for StorageProvider #9022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 35 additions & 22 deletions controllers/dataprotection/storageprovider_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ package dataprotection

import (
"context"
"slices"
"sync"

storagev1 "k8s.io/api/storage/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
Expand Down Expand Up @@ -80,18 +82,23 @@ func (r *StorageProviderReconciler) Reconcile(ctx context.Context, req ctrl.Requ
// get provider object
provider := &dpv1alpha1.StorageProvider{}
if err := r.Get(ctx, req.NamespacedName, provider); err != nil {
if apierrors.IsNotFound(err) {
r.removeDependency(req.Name)
return intctrlutil.Reconciled()
}
return intctrlutil.CheckedRequeueWithError(err, reqCtx.Log, "failed to get StorageProvider")
}

// add dependency to CSIDriver
r.ensureDependency(provider)

// handle finalizer
res, err := intctrlutil.HandleCRDeletion(reqCtx, r, provider, dptypes.DataProtectionFinalizerName, func() (*ctrl.Result, error) {
return nil, r.deleteExternalResources(reqCtx, provider)
})
if res != nil {
return *res, err
// We should not add a finalizer to the StorageProvider resource,
// because when KubeBlocks is uninstalled, the controller workload will be stopped first,
// so the finalizer will not be processed, preventing those StorageProvider resources
// from being deleted.
// Remove the finalizer if it's present.
if err := r.removeFinalizer(reqCtx, provider); err != nil {
return intctrlutil.CheckedRequeueWithError(err, reqCtx.Log, "failed to remove finalizer")
}

// check CSI driver if specified
Expand All @@ -117,6 +124,19 @@ func (r *StorageProviderReconciler) Reconcile(ctx context.Context, req ctrl.Requ
return intctrlutil.Reconciled()
}

func (r *StorageProviderReconciler) removeFinalizer(reqCtx intctrlutil.RequestCtx,
provider *dpv1alpha1.StorageProvider) error {
pos := slices.Index(provider.Finalizers, dptypes.DataProtectionFinalizerName)
if pos < 0 {
return nil
}
provider.Finalizers = slices.Delete(provider.Finalizers, pos, pos+1)
if err := r.Update(reqCtx.Ctx, provider); err != nil {
return err
}
return nil
}

func (r *StorageProviderReconciler) updateStatus(reqCtx intctrlutil.RequestCtx,
provider *dpv1alpha1.StorageProvider,
checkErr error) error {
Expand Down Expand Up @@ -195,28 +215,21 @@ func (r *StorageProviderReconciler) ensureDependency(provider *dpv1alpha1.Storag
r.driverDependencies[driverName] = append(list, provider.Name)
}

func (r *StorageProviderReconciler) removeDependency(provider *dpv1alpha1.StorageProvider) {
if provider.Spec.CSIDriverName == "" {
return
}
func (r *StorageProviderReconciler) removeDependency(providerName string) {
r.mu.Lock()
defer r.mu.Unlock()
list := r.driverDependencies[provider.Spec.CSIDriverName]
for i, x := range list {
if x == provider.Name {
list[i] = list[len(list)-1]
r.driverDependencies[provider.Spec.CSIDriverName] = list[:len(list)-1]
return
for driverName := range r.driverDependencies {
list := r.driverDependencies[driverName]
for i, x := range list {
if x == providerName {
list[i] = list[len(list)-1]
r.driverDependencies[driverName] = list[:len(list)-1]
break
}
}
}
}

func (r *StorageProviderReconciler) deleteExternalResources(
reqCtx intctrlutil.RequestCtx, provider *dpv1alpha1.StorageProvider) error {
r.removeDependency(provider)
return nil
}

// SetupWithManager sets up the controller with the Manager.
func (r *StorageProviderReconciler) SetupWithManager(mgr ctrl.Manager) error {
b := intctrlutil.NewControllerManagedBy(mgr).
Expand Down
9 changes: 1 addition & 8 deletions controllers/dataprotection/storageprovider_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ import (

dpv1alpha1 "github.com/apecloud/kubeblocks/apis/dataprotection/v1alpha1"
"github.com/apecloud/kubeblocks/pkg/constant"
dptypes "github.com/apecloud/kubeblocks/pkg/dataprotection/types"
intctrlutil "github.com/apecloud/kubeblocks/pkg/generics"
testapps "github.com/apecloud/kubeblocks/pkg/testutil/apps"
viper "github.com/apecloud/kubeblocks/pkg/viperx"
Expand Down Expand Up @@ -195,12 +194,6 @@ var _ = Describe("StorageProvider controller", func() {
By("creating a StorageProvider with csi3")
createStorageProviderSpec("csi3")

By("checking StorageProvider object")
Eventually(testapps.CheckObj(&testCtx, key, func(g Gomega, provider *dpv1alpha1.StorageProvider) {
reconcileNoError(g)
g.Expect(provider.GetFinalizers()).To(ContainElement(dptypes.DataProtectionFinalizerName))
})).Should(Succeed())

By("deleting StorageProvider object")
Eventually(func(g Gomega) {
reconcileNoError(g)
Expand All @@ -210,7 +203,7 @@ var _ = Describe("StorageProvider controller", func() {
return
}
g.Expect(err).ToNot(HaveOccurred())
Expect(testCtx.Cli.Delete(testCtx.Ctx, provider)).ToNot(HaveOccurred())
g.Expect(testCtx.Cli.Delete(testCtx.Ctx, provider)).ToNot(HaveOccurred())
}).Should(Succeed())
})
})
Expand Down
Loading