YuzuZensai/netbird-kubernetes-operator
1
0
Fork 0
mirror of https://github.com/YuzuZensai/netbird-kubernetes-operator.git synced 2026-09-13 10:49:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add path component to finalizer (#202)

Browse Source 
The Kubernetes client warns about not having a path component in the
finalizer. This change adds a unqiue path component for each reconciler
kind.
This commit is contained in:
Philip Laine
2026-04-23 19:18:06 +02:00
committed by GitHub
parent 9838f0dccc
commit 91036022c0
11 changed files with 38 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/v1alpha1/condition_types.go
-2
View File
@@ -1,7 +1,5 @@
package v1alpha1 package v1alpha1
const NetbirdFinalizer = "finalizers.netbird.io"
const ReadyCondition = "Ready" const ReadyCondition = "Ready"
const ( const (
internal/controller/gateway_controller.go
+3 -2
View File
@@ -33,6 +33,7 @@ import (
nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1" nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1"
"github.com/netbirdio/kubernetes-operator/internal/gatewayutil" "github.com/netbirdio/kubernetes-operator/internal/gatewayutil"
"github.com/netbirdio/kubernetes-operator/internal/k8sutil"
) )
type GatewayReconciler struct { type GatewayReconciler struct {
@@ -90,7 +91,7 @@ func (r *GatewayReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
Reason: string(gatewayv1.GatewayReasonAccepted), Reason: string(gatewayv1.GatewayReasonAccepted),
} }
meta.SetStatusCondition(&gw.Status.Conditions, cond) meta.SetStatusCondition(&gw.Status.Conditions, cond)
controllerutil.AddFinalizer(gw, nbv1alpha1.NetbirdFinalizer) controllerutil.AddFinalizer(gw, k8sutil.Finalizer("gateway"))
err = sp.Patch(ctx, gw) err = sp.Patch(ctx, gw)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
@@ -158,7 +159,7 @@ func (r *GatewayReconciler) reconcileDelete(ctx context.Context, sp *patch.Seria
} }
} }
controllerutil.RemoveFinalizer(gw, nbv1alpha1.NetbirdFinalizer) controllerutil.RemoveFinalizer(gw, k8sutil.Finalizer("gateway"))
err = sp.Patch(ctx, gw) err = sp.Patch(ctx, gw)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
internal/controller/gatewayclass_controller.go
+3 -3
View File
@@ -5,7 +5,7 @@ import (
"time" "time"
"github.com/fluxcd/pkg/runtime/patch" "github.com/fluxcd/pkg/runtime/patch"
nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1" "github.com/netbirdio/kubernetes-operator/internal/k8sutil"
"k8s.io/apimachinery/pkg/api/meta" "k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
ctrl "sigs.k8s.io/controller-runtime" ctrl "sigs.k8s.io/controller-runtime"
@@ -66,7 +66,7 @@ func (r *GatewayClassReconciler) Reconcile(ctx context.Context, req ctrl.Request
} }
// Set condition to accepted. // Set condition to accepted.
controllerutil.AddFinalizer(gwc, nbv1alpha1.NetbirdFinalizer) controllerutil.AddFinalizer(gwc, k8sutil.Finalizer("gatewayclass"))
cond := metav1.Condition{ cond := metav1.Condition{
Type: string(gatewayv1.GatewayClassConditionStatusAccepted), Type: string(gatewayv1.GatewayClassConditionStatusAccepted),
Status: metav1.ConditionTrue, Status: metav1.ConditionTrue,
@@ -93,7 +93,7 @@ func (r *GatewayClassReconciler) reconcileDelete(ctx context.Context, sp *patch.
} }
} }
controllerutil.RemoveFinalizer(gwc, nbv1alpha1.NetbirdFinalizer) controllerutil.RemoveFinalizer(gwc, k8sutil.Finalizer("gatewayclass"))
err = sp.Patch(ctx, gwc) err = sp.Patch(ctx, gwc)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
internal/controller/group_controller.go
+3 -2
View File
@@ -12,6 +12,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil" "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1" nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1"
"github.com/netbirdio/kubernetes-operator/internal/k8sutil"
) )
type GroupReconciler struct { type GroupReconciler struct {
@@ -35,7 +36,7 @@ func (r *GroupReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl
return r.reconcileDelete(ctx, sp, group) return r.reconcileDelete(ctx, sp, group)
} }
controllerutil.AddFinalizer(group, nbv1alpha1.NetbirdFinalizer) controllerutil.AddFinalizer(group, k8sutil.Finalizer("group"))
err = sp.Patch(ctx, group) err = sp.Patch(ctx, group)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
@@ -81,7 +82,7 @@ func (r *GroupReconciler) reconcileDelete(ctx context.Context, sp *patch.SerialP
} }
} }
controllerutil.RemoveFinalizer(group, nbv1alpha1.NetbirdFinalizer) controllerutil.RemoveFinalizer(group, k8sutil.Finalizer("group"))
err := sp.Patch(ctx, group) err := sp.Patch(ctx, group)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
internal/controller/httproute_controller.go
+5 -5
View File
@@ -19,7 +19,7 @@ import (
nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1" nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1"
"github.com/netbirdio/kubernetes-operator/internal/gatewayutil" "github.com/netbirdio/kubernetes-operator/internal/gatewayutil"
"github.com/netbirdio/kubernetes-operator/internal/ssautil" "github.com/netbirdio/kubernetes-operator/internal/k8sutil"
"github.com/netbirdio/kubernetes-operator/internal/util" "github.com/netbirdio/kubernetes-operator/internal/util"
nbv1alpha1ac "github.com/netbirdio/kubernetes-operator/pkg/applyconfigurations/api/v1alpha1" nbv1alpha1ac "github.com/netbirdio/kubernetes-operator/pkg/applyconfigurations/api/v1alpha1"
) )
@@ -66,7 +66,7 @@ func (r *HTTPRouteReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
return ctrl.Result{}, err return ctrl.Result{}, err
} }
controllerutil.AddFinalizer(hr, nbv1alpha1.NetbirdFinalizer) controllerutil.AddFinalizer(hr, k8sutil.Finalizer("httproute"))
err = sp.Patch(ctx, hr) err = sp.Patch(ctx, hr)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
@@ -87,12 +87,12 @@ func (r *HTTPRouteReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
} }
for _, svc := range svcIdx { for _, svc := range svcIdx {
controllerRef, err := ssautil.ControllerReference(&svc, r.Scheme()) controllerRef, err := k8sutil.ControllerReference(&svc, r.Scheme())
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
} }
controllerRef = controllerRef.WithBlockOwnerDeletion(false) controllerRef = controllerRef.WithBlockOwnerDeletion(false)
ownerRef, err := ssautil.OwnerReference(hr, r.Scheme()) ownerRef, err := k8sutil.OwnerReference(hr, r.Scheme())
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
} }
@@ -255,7 +255,7 @@ func (r *HTTPRouteReconciler) reconcileDelete(ctx context.Context, sp *patch.Ser
} }
} }
controllerutil.RemoveFinalizer(hr, nbv1alpha1.NetbirdFinalizer) controllerutil.RemoveFinalizer(hr, k8sutil.Finalizer("httproute"))
err = sp.Patch(ctx, hr) err = sp.Patch(ctx, hr)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
internal/controller/networkresource_controller.go
+3 -2
View File
@@ -24,6 +24,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/reconcile" "sigs.k8s.io/controller-runtime/pkg/reconcile"
nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1" nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1"
"github.com/netbirdio/kubernetes-operator/internal/k8sutil"
"github.com/netbirdio/kubernetes-operator/internal/netbirdutil" "github.com/netbirdio/kubernetes-operator/internal/netbirdutil"
) )
@@ -117,7 +118,7 @@ func (r *NetworkResourceReconciler) Reconcile(ctx context.Context, req ctrl.Requ
return ctrl.Result{}, err return ctrl.Result{}, err
} }
controllerutil.AddFinalizer(netResource, nbv1alpha1.NetbirdFinalizer) controllerutil.AddFinalizer(netResource, k8sutil.Finalizer("networkresource"))
resourceID, err := func() (string, error) { resourceID, err := func() (string, error) {
netReq := api.NetworkResourceRequest{ netReq := api.NetworkResourceRequest{
@@ -218,7 +219,7 @@ func (r *NetworkResourceReconciler) reconcileDelete(ctx context.Context, sp *pat
} }
} }
controllerutil.RemoveFinalizer(netResource, nbv1alpha1.NetbirdFinalizer) controllerutil.RemoveFinalizer(netResource, k8sutil.Finalizer("networkresource"))
err := sp.Patch(ctx, netResource) err := sp.Patch(ctx, netResource)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
internal/controller/networkrouter_controller.go
+4 -4
View File
@@ -10,8 +10,8 @@ import (
"github.com/fluxcd/pkg/runtime/conditions" "github.com/fluxcd/pkg/runtime/conditions"
"github.com/fluxcd/pkg/runtime/patch" "github.com/fluxcd/pkg/runtime/patch"
"github.com/netbirdio/kubernetes-operator/internal/k8sutil"
"github.com/netbirdio/kubernetes-operator/internal/netbirdutil" "github.com/netbirdio/kubernetes-operator/internal/netbirdutil"
"github.com/netbirdio/kubernetes-operator/internal/ssautil"
netbird "github.com/netbirdio/netbird/shared/management/client/rest" netbird "github.com/netbirdio/netbird/shared/management/client/rest"
"github.com/netbirdio/netbird/shared/management/http/api" "github.com/netbirdio/netbird/shared/management/http/api"
appsv1 "k8s.io/api/apps/v1" appsv1 "k8s.io/api/apps/v1"
@@ -55,7 +55,7 @@ func (r *NetworkRouterReconciler) Reconcile(ctx context.Context, req ctrl.Reques
return r.reconcileDelete(ctx, sp, netRouter) return r.reconcileDelete(ctx, sp, netRouter)
} }
ownerRef, err := ssautil.ControllerReference(netRouter, r.Scheme()) ownerRef, err := k8sutil.ControllerReference(netRouter, r.Scheme())
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
} }
@@ -66,7 +66,7 @@ func (r *NetworkRouterReconciler) Reconcile(ctx context.Context, req ctrl.Reques
return ctrl.Result{}, err return ctrl.Result{}, err
} }
controllerutil.AddFinalizer(netRouter, nbv1alpha1.NetbirdFinalizer) controllerutil.AddFinalizer(netRouter, k8sutil.Finalizer("networkrouter"))
networkID, err := func() (string, error) { networkID, err := func() (string, error) {
networkReq := api.NetworkRequest{ networkReq := api.NetworkRequest{
@@ -304,7 +304,7 @@ func (r *NetworkRouterReconciler) reconcileDelete(ctx context.Context, sp *patch
} }
} }
controllerutil.RemoveFinalizer(netRouter, nbv1alpha1.NetbirdFinalizer) controllerutil.RemoveFinalizer(netRouter, k8sutil.Finalizer("networkrouter"))
err := sp.Patch(ctx, netRouter) err := sp.Patch(ctx, netRouter)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
internal/controller/setupkey_controller.go
+4 -4
View File
@@ -18,8 +18,8 @@ import (
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil" "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1" nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1"
"github.com/netbirdio/kubernetes-operator/internal/k8sutil"
"github.com/netbirdio/kubernetes-operator/internal/netbirdutil" "github.com/netbirdio/kubernetes-operator/internal/netbirdutil"
"github.com/netbirdio/kubernetes-operator/internal/ssautil"
) )
const ( const (
@@ -41,7 +41,7 @@ func (r *SetupKeyReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
if err != nil { if err != nil {
return ctrl.Result{}, client.IgnoreNotFound(err) return ctrl.Result{}, client.IgnoreNotFound(err)
} }
owner, err := ssautil.ControllerReference(setupKey, r.Client.Scheme()) owner, err := k8sutil.ControllerReference(setupKey, r.Client.Scheme())
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
} }
@@ -56,7 +56,7 @@ func (r *SetupKeyReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
return ctrl.Result{}, err return ctrl.Result{}, err
} }
controllerutil.AddFinalizer(setupKey, nbv1alpha1.NetbirdFinalizer) controllerutil.AddFinalizer(setupKey, k8sutil.Finalizer("setupkey"))
err = sp.Patch(ctx, setupKey) err = sp.Patch(ctx, setupKey)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
@@ -177,7 +177,7 @@ func (r *SetupKeyReconciler) reconcileDelete(ctx context.Context, sp *patch.Seri
} }
} }
controllerutil.RemoveFinalizer(setupKey, nbv1alpha1.NetbirdFinalizer) controllerutil.RemoveFinalizer(setupKey, k8sutil.Finalizer("setupkey"))
err := sp.Patch(ctx, setupKey) err := sp.Patch(ctx, setupKey)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
internal/controller/tcproute_controller.go
+5 -5
View File
@@ -16,7 +16,7 @@ import (
"github.com/fluxcd/pkg/runtime/patch" "github.com/fluxcd/pkg/runtime/patch"
nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1" nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1"
"github.com/netbirdio/kubernetes-operator/internal/gatewayutil" "github.com/netbirdio/kubernetes-operator/internal/gatewayutil"
"github.com/netbirdio/kubernetes-operator/internal/ssautil" "github.com/netbirdio/kubernetes-operator/internal/k8sutil"
nbv1alpha1ac "github.com/netbirdio/kubernetes-operator/pkg/applyconfigurations/api/v1alpha1" nbv1alpha1ac "github.com/netbirdio/kubernetes-operator/pkg/applyconfigurations/api/v1alpha1"
) )
@@ -56,7 +56,7 @@ func (r *TCPRouteReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
return ctrl.Result{}, err return ctrl.Result{}, err
} }
controllerutil.AddFinalizer(tr, nbv1alpha1.NetbirdFinalizer) controllerutil.AddFinalizer(tr, k8sutil.Finalizer("tcproute"))
err = sp.Patch(ctx, tr) err = sp.Patch(ctx, tr)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
@@ -77,12 +77,12 @@ func (r *TCPRouteReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
} }
for _, svc := range svcIdx { for _, svc := range svcIdx {
controllerRef, err := ssautil.ControllerReference(&svc, r.Scheme()) controllerRef, err := k8sutil.ControllerReference(&svc, r.Scheme())
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
} }
controllerRef = controllerRef.WithBlockOwnerDeletion(false) controllerRef = controllerRef.WithBlockOwnerDeletion(false)
ownerRef, err := ssautil.OwnerReference(tr, r.Scheme()) ownerRef, err := k8sutil.OwnerReference(tr, r.Scheme())
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
} }
@@ -159,7 +159,7 @@ func (r *TCPRouteReconciler) reconcileDelete(ctx context.Context, sp *patch.Seri
} }
} }
controllerutil.RemoveFinalizer(tr, nbv1alpha1.NetbirdFinalizer) controllerutil.RemoveFinalizer(tr, k8sutil.Finalizer("tcproute"))
err := sp.Patch(ctx, tr) err := sp.Patch(ctx, tr)
if err != nil { if err != nil {
return ctrl.Result{}, err return ctrl.Result{}, err
internal/k8sutil/finalizer.go
+7
View File
@@ -0,0 +1,7 @@
package k8sutil
const NetbirdFinalizer = "finalizers.netbird.io"
func Finalizer(kind string) string {
return NetbirdFinalizer + "/" + kind
}
internal/ssautil/ssautil.go → internal/k8sutil/owner.go
+1 -1
View File
@@ -1,4 +1,4 @@
package ssautil package k8sutil
import ( import (
"k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/runtime"