kubernetes-operator

module
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 16, 2026 License: BSD-3-Clause

README

NetBird Kubernetes Operator

The NetBird Kubernetes Operator automates the provisioning of NetBird network access for services running in your cluster. It extends the Kubernetes API with CRDs, letting you manage NetBird peers, routes, and groups declaratively, the same way you manage the rest of your infrastructure.

Features

  • Declarative peer management - define NetBird peers as Kubernetes resources and let the operator handle provisioning and lifecycle
  • Automatic secret management - setup keys and credentials are stored and rotated as Kubernetes secrets
  • Namespace-scoped or cluster-wide - deploy per-namespace for multi-tenant clusters or cluster-wide for full coverage
  • Works with any NetBird deployment - compatible with NetBird Cloud and self-hosted instances

Getting Started

For full setup instructions, see the Getting Started documentation.

Once your secret is configured, install the operator with Helm.

helm upgrade --install --create-namespace -n netbird netbird-operator oci://ghcr.io/netbirdio/helm-charts/netbird-operator

API

Kind API Version
Group netbird.io/v1alpha1
NetworkResource netbird.io/v1alpha1
NetworkRouter netbird.io/v1alpha1
SetupKey netbird.io/v1alpha1
SidecarProfile netbird.io/v1alpha1
ClusterProxy netbird.io/v1alpha1

Directories

Path Synopsis
api
v1
Package v1 contains API Schema definitions for the v1 API group.
Package v1 contains API Schema definitions for the v1 API group.
v1alpha1
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group.
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group.
internal
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL