mirror of
https://github.com/YuzuZensai/netbird-kubernetes-operator.git
synced 2026-09-13 10:49:15 +00:00
Philip LaineandGitHub
84e9bff602
The PR #335 is adding controller tests for the HTTP route which means it needs the CRDs. So simplify future testing work we will vendor the CRDs from the release inside of the testdata directory. This is setup so that changes to the GW API version will force generate to be run again. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Chores** * Updated the generated Gateway API artifacts used in the build pipeline to ensure the latest `standard-install.yaml` content is bundled. * Kept the bundled Gateway API version synchronized automatically by deriving it from the project’s module version and regenerating the asset when dependencies change. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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 |