mirror of https://github.com/YuzuZensai/netbird-kubernetes-operator.git synced 2026-09-13 18:59:09 +00:00

Files

T

Philip LaineandGitHub da90b6ae42 Add groups option to cluster proxy (#297 )

This change adds an option to specify groups a cluster proxy peer is a
member of.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added optional `spec.groups` to the ClusterProxy custom resource to
associate group references by `id`, `name`, or `localRef`.
* CRD schema includes OpenAPI validation to enforce that each group
reference specifies exactly one selector.

* **Bug Fixes**
* Improved deep-copy behavior for ClusterProxy spec so group references
are copied safely and don’t share underlying slices.

* **Documentation**
* Updated API reference docs and README API table to include the new
`groups` field.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

2026-06-16 10:49:57 +02:00

1.6 KiB

Raw Blame History

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`

1.6 KiB Raw Blame History

NetBird Kubernetes Operator

Features

Getting Started

API

1.6 KiB

Raw Blame History