Philip LaineandGitHub dd054d50ec Update documentation with refactored resources (#204)
This updates the documentation and examples to use the new resources. It
also adds automatic documentation creation for the api reference.

Signed-off-by: Philip Laine <philip.laine@gmail.com>
2026-04-24 16:22:04 +02:00
2025-05-02 19:37:36 +02:00
2025-03-19 15:12:18 +01:00
2025-01-24 13:01:03 +01:00
2026-04-23 19:17:53 +02:00

NetBird Kubernetes Operator

The NetBird Kubernetes Operator automates the provisioning of NetBird network access for services running in your cluster.

Documentation

How It Works

A NetworkRouter registers a NetBird router peer for a given DNS zone in your cluster.

apiVersion: netbird.io/v1alpha1
kind: NetworkRouter
metadata:
  name: prod
  namespace: netbird
spec:
  dnsZoneRef:
    name: prod.company.internal

A NetworkResource then exposes a Kubernetes service through that router to one or more NetBird groups.

apiVersion: netbird.io/v1alpha1
kind: NetworkResource
metadata:
  name: nginx
  namespace: default
spec:
  networkRouterRef:
    name: prod
    namespace: netbird
  serviceRef:
    name: nginx
  groups:
    - name: All
S
Description
Kubernetes operator for Netbird
Readme BSD-3-Clause
1.2 MiB
Languages
Go 97.8%
Makefile 1.2%
Go Template 0.9%
Dockerfile 0.1%