admin/kubesphere
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: workspace cascading deletion logic (#6249)

Browse Source 
Signed-off-by: hongming <coder.scala@gmail.com>
This commit is contained in:
hongming
2024-10-30 17:42:06 +08:00
committed by GitHub
parent 9aa17af5db
commit d63a24fc91
7 changed files with 190 additions and 179 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
pkg/controller/namespace/namespace_controller.go
View File

@@ -13,15 +13,12 @@ import (
"github.com/go-logr/logr"
corev1 "k8s.io/api/core/v1"
rbacv1 "k8s.io/api/rbac/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/yaml"
"k8s.io/client-go/tools/record"
"k8s.io/klog/v2"
iamv1beta1 "kubesphere.io/api/iam/v1beta1"
"kubesphere.io/api/tenant/v1beta1"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
@@ -30,13 +27,10 @@ import (
"kubesphere.io/kubesphere/pkg/constants"
kscontroller "kubesphere.io/kubesphere/pkg/controller"
"kubesphere.io/kubesphere/pkg/scheme"
"kubesphere.io/kubesphere/pkg/utils/k8sutil"
)
const (
controllerName = "namespace"
finalizer = "finalizers.kubesphere.io/namespaces"
)
var _ kscontroller.Controller = &Reconciler{}
@@ -65,10 +59,9 @@ func (r *Reconciler) SetupWithManager(mgr *kscontroller.Manager) error {
}
// +kubebuilder:rbac:groups="",resources=namespaces,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=tenant.kubesphere.io,resources=workspaces,verbs=get;list;watch
// +kubebuilder:rbac:groups=iam.kubesphere.io,resources=rolebases,verbs=get;list;watch
// +kubebuilder:rbac:groups=rbac.authorization.k8s.io,resources=roles,verbs=get;list;watch
// +kubebuilder:rbac:groups=rbac.authorization.k8s.io,resources=rolebindings,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=iam.kubesphere.io,resources=builtinroles,verbs=get;list;watch
// +kubebuilder:rbac:groups=iam.kubesphere.io,resources=roles,verbs=get;list;watch
// +kubebuilder:rbac:groups=iam.kubesphere.io,resources=rolebindings,verbs=get;list;watch
func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
logger := r.logger.WithValues("namespace", req.NamespacedName)
@@ -78,21 +71,30 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
return ctrl.Result{}, client.IgnoreNotFound(err)
}
// Skip the namespace that is not created in workspace
if _, ok := namespace.Labels[constants.WorkspaceLabelKey]; !ok {
return ctrl.Result{}, nil
}
if namespace.ObjectMeta.DeletionTimestamp.IsZero() {
// The object is not being deleted, so if it does not have our finalizer,
// then lets add the finalizer and update the object.
if !controllerutil.ContainsFinalizer(namespace, finalizer) {
if !controllerutil.ContainsFinalizer(namespace, constants.CascadingDeletionFinalizer) {
if err := r.initCreatorRoleBinding(ctx, namespace); err != nil {
return ctrl.Result{}, err
}
updated := namespace.DeepCopy()
controllerutil.AddFinalizer(updated, finalizer)
// Remove legacy finalizer
controllerutil.RemoveFinalizer(updated, "finalizers.kubesphere.io/namespaces")
// Remove legacy ownerReferences
updated.OwnerReferences = make([]metav1.OwnerReference, 0)
controllerutil.AddFinalizer(updated, constants.CascadingDeletionFinalizer)
return ctrl.Result{}, r.Patch(ctx, updated, client.MergeFrom(namespace))
}
} else {
// The object is being deleted
if controllerutil.ContainsFinalizer(namespace, finalizer) {
controllerutil.RemoveFinalizer(namespace, finalizer)
if controllerutil.ContainsFinalizer(namespace, constants.CascadingDeletionFinalizer) {
controllerutil.RemoveFinalizer(namespace, constants.CascadingDeletionFinalizer)
if err := r.Update(ctx, namespace); err != nil {
return ctrl.Result{}, err
}
@@ -105,64 +107,15 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
return ctrl.Result{}, err
}
if err := r.reconcileWorkspaceOwnerReference(ctx, namespace); err != nil {
return ctrl.Result{}, err
}
r.recorder.Event(namespace, corev1.EventTypeNormal, kscontroller.Synced, kscontroller.MessageResourceSynced)
return ctrl.Result{}, nil
}
func (r *Reconciler) reconcileWorkspaceOwnerReference(ctx context.Context, namespace *corev1.Namespace) error {
workspaceName, hasWorkspaceLabel := namespace.Labels[v1beta1.WorkspaceLabel]
if !hasWorkspaceLabel {
if k8sutil.IsControlledBy(namespace.OwnerReferences, v1beta1.ResourceKindWorkspace, workspaceName) {
namespace.OwnerReferences = k8sutil.RemoveWorkspaceOwnerReference(namespace.OwnerReferences)
return r.Update(ctx, namespace)
}
// noting to do
return nil
}
workspace := &v1beta1.Workspace{}
if err := r.Get(ctx, types.NamespacedName{Name: workspaceName}, workspace); err != nil {
owner := metav1.GetControllerOf(namespace)
if errors.IsNotFound(err) && owner != nil && owner.Kind == v1beta1.ResourceKindWorkspace {
namespace.OwnerReferences = k8sutil.RemoveWorkspaceOwnerReference(namespace.OwnerReferences)
return r.Update(ctx, namespace)
}
return client.IgnoreNotFound(err)
}
// workspace has been deleted
if !workspace.ObjectMeta.DeletionTimestamp.IsZero() {
return nil
}
if !metav1.IsControlledBy(namespace, workspace) && namespace.Labels[constants.KubeSphereManagedLabel] == "true" {
namespace = namespace.DeepCopy()
if err := controllerutil.SetControllerReference(workspace, namespace, scheme.Scheme); err != nil {
return err
}
if err := r.Update(ctx, namespace); err != nil {
return err
}
}
return nil
}
func (r *Reconciler) initRoles(ctx context.Context, namespace *corev1.Namespace) error {
if _, ok := namespace.Labels[constants.WorkspaceLabelKey]; !ok {
return nil
}
logger := klog.FromContext(ctx)
var templates iamv1beta1.BuiltinRoleList
matchingLabels := client.MatchingLabels{iamv1beta1.ScopeLabel: iamv1beta1.ScopeNamespace}
if err := r.List(ctx, &templates, matchingLabels); err != nil {
return err
if err := r.List(ctx, &templates, client.MatchingLabels{iamv1beta1.ScopeLabel: iamv1beta1.ScopeNamespace}); err != nil {
return fmt.Errorf("failed to list builtin roles: %v", err)
}
for _, template := range templates.Items {
selector, err := metav1.LabelSelectorAsSelector(&template.TargetSelector)
@@ -185,9 +138,9 @@ func (r *Reconciler) initRoles(ctx context.Context, namespace *corev1.Namespace)
return nil
})
if err != nil {
return err
return fmt.Errorf("failed to create or update builtin role: %v", err)
}
logger.V(4).Info("builtin role successfully initialized", "operation", op)
logger.V(4).Info("builtin role initialized", "operation", op)
} else if err != nil {
logger.Error(err, "invalid builtin role found", "name", template.Name)
}
@@ -228,6 +181,6 @@ func (r *Reconciler) initCreatorRoleBinding(ctx context.Context, namespace *core
if err != nil {
return err
}
klog.FromContext(ctx).V(4).Info("creator role binding successfully initialized", "operation", op)
klog.FromContext(ctx).V(4).Info("creator role binding initialized", "operation", op)
return nil
}

30
pkg/controller/namespace/namespace_controller_test.go
View File

@@ -54,41 +54,17 @@ var _ = Describe("Namespace", func() {
Expect(k8sClient.Create(context.Background(), namespace)).Should(Succeed())
By("Expecting to create namespace successfully")
Eventually(func() bool {
k8sClient.Get(context.Background(), types.NamespacedName{Name: namespace.Name}, namespace)
return !namespace.CreationTimestamp.IsZero()
}, timeout, interval).Should(BeTrue())
By("Expecting to set owner reference successfully")
Eventually(func() bool {
k8sClient.Get(context.Background(), types.NamespacedName{Name: namespace.Name}, namespace)
return len(namespace.OwnerReferences) > 0
}, timeout, interval).Should(BeTrue())
Expect(k8sClient.Get(context.Background(), types.NamespacedName{Name: workspace.Name}, workspace)).Should(Succeed())
controlled := true
expectedOwnerReference := metav1.OwnerReference{
Kind: workspace.Kind,
APIVersion: workspace.APIVersion,
UID: workspace.UID,
Name: workspace.Name,
Controller: &controlled,
BlockOwnerDeletion: &controlled,
}
By("Expecting to bind workspace successfully")
Expect(namespace.OwnerReferences).To(ContainElement(expectedOwnerReference))
Expect(k8sClient.Get(context.Background(), types.NamespacedName{Name: workspace.Name}, workspace)).Should(Succeed())
Expect(k8sClient.Get(context.Background(), types.NamespacedName{Name: namespace.Name}, namespace)).Should(Succeed())
By("Expecting to update namespace successfully")
updated := namespace.DeepCopy()
updated.Labels[constants.WorkspaceLabelKey] = "workspace-not-exist"
Expect(k8sClient.Update(context.Background(), updated)).Should(Succeed())
By("Expecting to unbind workspace successfully")
Eventually(func() bool {
k8sClient.Get(context.Background(), types.NamespacedName{Name: namespace.Name}, namespace)
_ = k8sClient.Get(context.Background(), types.NamespacedName{Name: namespace.Name}, namespace)
return len(namespace.OwnerReferences) == 0
}, timeout, interval).Should(BeTrue())
})