Refactor uninstallation process (#74)

Docs PR: https://github.com/netbirdio/docs/pull/457

Changes:
* Split kubernetes-operator Chart to operator only chart
(kubernetes-operator) and configuration chart (netbird-operator-config)
* Remove delete validation webhooks for non-needed resources
* Allow abandoning Groups when still linked to a resource for over a
minute after deletion
* Fix duplciate Network Resource retrying heavily
* Fix SetupKey creation duplication
* Skip deleting routing peer since deleting network automatically
deletes it anyway
This commit is contained in:
M. Essam
2025-11-25 20:36:17 +02:00
committed by GitHub
parent 6c855c5d4e
commit f1b131be7d
31 changed files with 580 additions and 721 deletions
+1 -1
View File
@@ -151,7 +151,7 @@ func (r *NBGroupReconciler) handleDelete(ctx context.Context, nbGroup netbirdiov
return err
}
if err != nil && strings.Contains(err.Error(), "linked") {
if err != nil && strings.Contains(err.Error(), "linked") && !nbGroup.DeletionTimestamp.Add(time.Minute).Before(time.Now()) {
logger.Info("group still linked to resources on netbird", "err", err)
// Check if group is defined elsewhere in the cluster
var groups netbirdiov1.NBGroupList
+35 -1
View File
@@ -2,11 +2,15 @@ package controller
import (
"context"
nerrors "errors"
"fmt"
"slices"
"strings"
"time"
corev1 "k8s.io/api/core/v1"
"sigs.k8s.io/controller-runtime/pkg/log"
"k8s.io/apimachinery/pkg/api/errors"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
@@ -23,6 +27,10 @@ import (
"github.com/netbirdio/netbird/management/server/http/api"
)
var (
errDuplicateResource = fmt.Errorf("duplicate resource")
)
// NBResourceReconciler reconciles a NBResource object
type NBResourceReconciler struct {
client.Client
@@ -87,6 +95,10 @@ func (r *NBResourceReconciler) Reconcile(ctx context.Context, req ctrl.Request)
}
resource, err := r.handleNetBirdResource(ctx, nbResource, groupIDs, logger)
if err != nil && nerrors.Is(err, errDuplicateResource) {
return ctrl.Result{RequeueAfter: defaultRequeueAfter}, nil
}
if err != nil {
nbResource.Status.Conditions = netbirdiov1.NBConditionFalse("internalError", fmt.Sprintf("Error occurred handling NetBird Network Resource: %v", err))
return ctrl.Result{}, err
@@ -406,6 +418,12 @@ func (r *NBResourceReconciler) handleNetBirdResource(ctx context.Context, nbReso
Name: nbResource.Spec.Name,
})
if err != nil && strings.Contains(err.Error(), "already exists") {
log.Log.Error(errNetBirdAPI, "network resource with the same name already exists", "err", err)
nbResource.Status.Conditions = netbirdiov1.NBConditionFalse("DuplicateName", "Resource name already exists")
return nil, errDuplicateResource
}
if err != nil {
logger.Error(errNetBirdAPI, "error creating resource", "err", err)
return nil, err
@@ -562,6 +580,22 @@ func (r *NBResourceReconciler) handleGroups(ctx context.Context, req ctrl.Reques
}
func (r *NBResourceReconciler) handleDelete(ctx context.Context, req ctrl.Request, nbResource *netbirdiov1.NBResource, logger logr.Logger) error {
var svc corev1.Service
err := r.Client.Get(ctx, req.NamespacedName, &svc)
if !errors.IsNotFound(err) {
logger.Error(errKubernetesAPI, "error getting Service", "err", err, "svc", req.NamespacedName.String())
return err
} else if err == nil {
if _, ok := svc.Annotations[ServiceExposeAnnotation]; ok {
delete(svc.Annotations, ServiceExposeAnnotation)
err = r.Client.Update(ctx, &svc)
if err != nil {
logger.Error(errKubernetesAPI, "error updating Service", "err", err, "svc", req.NamespacedName.String())
return err
}
}
}
if nbResource.Status.PolicyName != nil {
for _, policy := range util.SplitTrim(*nbResource.Status.PolicyName, ",") {
var nbPolicy netbirdiov1.NBPolicy
@@ -593,7 +627,7 @@ func (r *NBResourceReconciler) handleDelete(ctx context.Context, req ctrl.Reques
}
nbGroupList := netbirdiov1.NBGroupList{}
err := r.Client.List(ctx, &nbGroupList, &client.ListOptions{Namespace: req.Namespace})
err = r.Client.List(ctx, &nbGroupList, &client.ListOptions{Namespace: req.Namespace})
if err != nil {
logger.Error(errKubernetesAPI, "error listing NBGroup", "err", err)
return err
+18 -19
View File
@@ -52,12 +52,6 @@ func (r *NBRoutingPeerReconciler) Reconcile(ctx context.Context, req ctrl.Reques
originalNBRP := nbrp.DeepCopy()
defer func() {
if err != nil {
// double check result is nil, otherwise error is not printed
// and exponential backoff doesn't work properly
res = ctrl.Result{}
return
}
if originalNBRP.DeletionTimestamp != nil && len(nbrp.Finalizers) == 0 {
return
}
@@ -67,6 +61,12 @@ func (r *NBRoutingPeerReconciler) Reconcile(ctx context.Context, req ctrl.Reques
logger.Error(errKubernetesAPI, "error updating NBRoutingPeer Status", "err", err)
}
}
if err != nil {
// double check result is nil, otherwise error is not printed
// and exponential backoff doesn't work properly
res = ctrl.Result{}
return
}
if !res.Requeue && res.RequeueAfter == 0 {
res.RequeueAfter = defaultRequeueAfter
}
@@ -210,7 +210,7 @@ func (r *NBRoutingPeerReconciler) handleDeployment(ctx context.Context, req ctrl
nbrp.Status.Conditions = netbirdiov1.NBConditionFalse("internalError", fmt.Sprintf("error creating Deployment: %v", err))
return err
}
} else {
} else if err == nil {
updatedDeployment := routingPeerDeployment.DeepCopy()
updatedDeployment.ObjectMeta.Name = nbrp.Name
updatedDeployment.ObjectMeta.Namespace = nbrp.Namespace
@@ -291,7 +291,7 @@ func (r *NBRoutingPeerReconciler) handleDeployment(ctx context.Context, req ctrl
}
}
return nil
return err
}
// handleRouter reconcile network routing peer in NetBird management API
@@ -393,6 +393,14 @@ func (r *NBRoutingPeerReconciler) handleSetupKey(ctx context.Context, req ctrl.R
}
err = r.Client.Create(ctx, &skSecret)
if errors.IsAlreadyExists(err) {
err = r.Client.Get(ctx, req.NamespacedName, &skSecret)
if err != nil {
logger.Error(errNetBirdAPI, "error getting secret", "err", err)
return &ctrl.Result{}, err
}
skSecret.Data = map[string][]byte{
"setupKey": []byte(setupKey.Key),
}
err = r.Client.Update(ctx, &skSecret)
}
@@ -410,7 +418,7 @@ func (r *NBRoutingPeerReconciler) handleSetupKey(ctx context.Context, req ctrl.R
return &ctrl.Result{}, err
}
if err != nil || setupKey.Revoked {
if (err != nil && strings.Contains(err.Error(), "not found")) || setupKey == nil || setupKey.Revoked {
if setupKey != nil && setupKey.Revoked {
err = r.netbird.SetupKeys.Delete(ctx, *nbrp.Status.SetupKeyID)
@@ -586,16 +594,6 @@ func (r *NBRoutingPeerReconciler) handleDelete(ctx context.Context, req ctrl.Req
logger.Info("Setup key deleted", "id", setupKeyID)
}
if nbrp.Status.RouterID != nil {
err = r.netbird.Networks.Routers(*nbrp.Status.NetworkID).Delete(ctx, *nbrp.Status.RouterID)
if err != nil && !strings.Contains(err.Error(), "not found") {
logger.Error(errNetBirdAPI, "error deleting Network Router", "err", err)
return ctrl.Result{}, err
}
nbrp.Status.RouterID = nil
}
nbGroup := netbirdiov1.NBGroup{}
err = r.Client.Get(ctx, req.NamespacedName, &nbGroup)
if err != nil && !errors.IsNotFound(err) {
@@ -631,6 +629,7 @@ func (r *NBRoutingPeerReconciler) handleDelete(ctx context.Context, req ctrl.Req
}
nbrp.Status.NetworkID = nil
nbrp.Status.RouterID = nil
}
}
@@ -912,10 +912,8 @@ var _ = Describe("NBRoutingPeer Controller", func() {
})
When("NBRoutingPeer is set for deletion", func() {
networkDeleted := false
routerDeleted := false
BeforeEach(func() {
networkDeleted = false
routerDeleted = false
nbroutingpeer.Status.SetupKeyID = util.Ptr("skid")
Expect(k8sClient.Status().Update(ctx, nbroutingpeer)).To(Succeed())
@@ -953,14 +951,6 @@ var _ = Describe("NBRoutingPeer Controller", func() {
Expect(err).NotTo(HaveOccurred())
networkDeleted = true
})
mux.HandleFunc("/api/networks/test/routers/test", func(w http.ResponseWriter, r *http.Request) {
defer GinkgoRecover()
Expect(r.Method).To(Equal(http.MethodDelete))
_, err = w.Write([]byte(`{}`))
Expect(err).NotTo(HaveOccurred())
routerDeleted = true
})
})
It("should remove finalizer from NBGroup", func() {
@@ -980,7 +970,7 @@ var _ = Describe("NBRoutingPeer Controller", func() {
NamespacedName: typeNamespacedName,
})
Expect(err).NotTo(HaveOccurred())
Expect(routerDeleted).To(BeTrue())
Expect(networkDeleted).To(BeTrue())
})
It("should delete Network", func() {