mirror of
https://github.com/YuzuZensai/netbird-kubernetes-operator.git
synced 2026-09-13 10:49:15 +00:00
Philip LaineandGitHub
41d995671f
Found a typo in rbac and issue with example while preparing walk-through docs. <!-- codesmith:footer --> --- <a href="https://app.blacksmith.sh/netbirdio/codesmith/kubernetes-operator/pr/374"><picture><source media="(prefers-color-scheme: dark)" srcset="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-dark-v2.svg"><source media="(prefers-color-scheme: light)" srcset="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-light-v2.svg"><img alt="View with Codesmith" src="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-dark-v2.svg"></picture></a> <a href="https://backend.blacksmith.sh/track/enable-autofix?expires=1786871474&installation_id=146802194&pr_number=374&repository=netbirdio%2Fkubernetes-operator&return_to=https%3A%2F%2Fgithub.com%2Fnetbirdio%2Fkubernetes-operator%2Fpull%2F374&signature=050e666d4eacb869624c2045bdedd563bc789a733a0882abb61ae5c880528c3f"><picture><source media="(prefers-color-scheme: dark)" srcset="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-light.svg"><img alt="Autofix with Codesmith" src="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-dark.svg"></picture></a> <sup>Need help on this PR? Tag <code>/codesmith</code> with what you need. Autofix is disabled.</sup> <!-- codesmith:autofix:disabled --> <!-- /codesmith:footer --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Bug Fixes** * Corrected permissions for accessing NetworkEgress status resources. * **Examples** * Updated the NetworkEgress example to target a service by fully qualified domain name instead of a static IP address. <!-- 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 |
|---|---|
| SetupKey | netbird.io/v1alpha1 |
| Group | netbird.io/v1alpha1 |
| NetworkRouter | netbird.io/v1alpha1 |
| NetworkResource | netbird.io/v1alpha1 |
| NetworkEgress | netbird.io/v1alpha1 |
| SidecarProfile | netbird.io/v1alpha1 |
| ClusterProxy | netbird.io/v1alpha1 |