Add network router and resource (#189)

This change adds two new resources, NetworkRouter and NetworkResource, which enable clusters to expose Kubernetes services to Netbird. The NetworkRouter is responsible for creating the network, group, setup key and routing peer all of which are unique to the isntance. Along with the deployment of the client in the cluster. The NetworkResource exposes a service by linking to the specific router it wants to expose to. This makes coupling between the resource and network easy to understand. Routers also set a DNS zone which is used to give names to resources based on the name and namespace of the service being exposed. Part of #172 Signed-off-by: Philip Laine <philip.laine@gmail.com>
2026-09-13 10:49:15 +00:00 · 2026-04-23 08:55:49 +02:00
parent af11e31b28
commit 6768a76c9c
38 changed files with 2973 additions and 55 deletions
@@ -0,0 +1,147 @@
+package controller
+
+import (
+	"context"
+	"fmt"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	appsv1 "k8s.io/api/apps/v1"
+	corev1 "k8s.io/api/core/v1"
+	kerrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/reconcile"
+
+	nbv1alpha1 "github.com/netbirdio/kubernetes-operator/api/v1alpha1"
+	"github.com/netbirdio/kubernetes-operator/internal/netbirdmock"
+	"github.com/netbirdio/netbird/shared/management/http/api"
+)
+
+var _ = Describe("NetworkRouter Controller", func() {
+	Context("When reconciling a resource", func() {
+		ctx := context.Background()
+
+		var netRouterRec *NetworkRouterReconciler
+		var setupKeyRec *SetupKeyReconciler
+		var groupRec *GroupReconciler
+
+		nn := client.ObjectKey{
+			Name:      "test-resource",
+			Namespace: "network-router",
+		}
+
+		BeforeEach(func() {
+			nbClient := netbirdmock.Client()
+			netRouterRec = &NetworkRouterReconciler{
+				Client:        k8sClient,
+				Netbird:       nbClient,
+				ClientImage:   "docker.io/netbirdio/netbird:latest",
+				ManagementURL: "https://netbird.io",
+			}
+			setupKeyRec = &SetupKeyReconciler{
+				Client:  k8sClient,
+				Netbird: nbClient,
+			}
+			groupRec = &GroupReconciler{
+				Client:  k8sClient,
+				Netbird: nbClient,
+			}
+
+			ns := &corev1.Namespace{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: nn.Namespace,
+				},
+			}
+			Expect(k8sClient.Create(ctx, ns)).To(Succeed())
+		})
+
+		AfterEach(func() {
+			ns := &corev1.Namespace{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: nn.Namespace,
+				},
+			}
+			err := k8sClient.Get(ctx, client.ObjectKeyFromObject(ns), ns)
+			if kerrors.IsNotFound(err) {
+				return
+			}
+			Expect(err).ToNot(HaveOccurred())
+			Expect(k8sClient.Delete(ctx, ns)).To(Succeed())
+		})
+
+		It("creates a routing peer along with a deployment", func() {
+			zoneReq := api.ZoneRequest{
+				Name:   "cluster.local",
+				Domain: "cluster.local",
+			}
+			_, err := netRouterRec.Netbird.DNSZones.CreateZone(ctx, zoneReq)
+			Expect(err).ToNot(HaveOccurred())
+
+			netRouter := &nbv1alpha1.NetworkRouter{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      nn.Name,
+					Namespace: nn.Namespace,
+				},
+				Spec: nbv1alpha1.NetworkRouterSpec{
+					DNSZoneRef: nbv1alpha1.DNSZoneReference{
+						Name: "cluster.local",
+					},
+				},
+			}
+			Expect(k8sClient.Create(ctx, netRouter)).To(Succeed())
+
+			group := &nbv1alpha1.Group{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      fmt.Sprintf("networkrouter-%s", netRouter.Name),
+					Namespace: nn.Namespace,
+				},
+			}
+			setupKey := &nbv1alpha1.SetupKey{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      fmt.Sprintf("networkrouter-%s", netRouter.Name),
+					Namespace: nn.Namespace,
+				},
+			}
+			dep := &appsv1.Deployment{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      fmt.Sprintf("networkrouter-%s", netRouter.Name),
+					Namespace: nn.Namespace,
+				},
+			}
+
+			for range 3 {
+				_, err := netRouterRec.Reconcile(ctx, reconcile.Request{NamespacedName: nn})
+				Expect(err).NotTo(HaveOccurred())
+
+				_, err = groupRec.Reconcile(ctx, reconcile.Request{NamespacedName: client.ObjectKeyFromObject(group)})
+				Expect(err).NotTo(HaveOccurred())
+
+				_, err = setupKeyRec.Reconcile(ctx, reconcile.Request{NamespacedName: client.ObjectKeyFromObject(setupKey)})
+				Expect(err).NotTo(HaveOccurred())
+			}
+
+			err = k8sClient.Get(ctx, nn, netRouter)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(netRouter.Status.NetworkID).ToNot(BeEmpty())
+			_, err = netRouterRec.Netbird.Networks.Routers(netRouter.Status.NetworkID).Get(ctx, netRouter.Status.RoutingPeerID)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = k8sClient.Get(ctx, client.ObjectKeyFromObject(group), group)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(group.OwnerReferences[0].UID).To(Equal(netRouter.UID))
+
+			err = k8sClient.Get(ctx, client.ObjectKeyFromObject(setupKey), setupKey)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(setupKey.OwnerReferences[0].UID).To(Equal(netRouter.UID))
+
+			err = k8sClient.Get(ctx, client.ObjectKeyFromObject(dep), dep)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(dep.OwnerReferences[0].UID).To(Equal(netRouter.UID))
+
+			routingPeerResp, err := netRouterRec.Netbird.Networks.Routers(netRouter.Status.NetworkID).Get(ctx, netRouter.Status.RoutingPeerID)
+			Expect(err).NotTo(HaveOccurred())
+			Expect((*routingPeerResp.PeerGroups)[0]).To(Equal(group.Status.GroupID))
+		})
+	})
+})