mirror of
https://github.com/YuzuZensai/netbird-kubernetes-operator.git
synced 2026-09-13 10:49:15 +00:00
Philip LaineandGitHub
10f40da0e7
This change adds a NetBird server to the e2e test and ensures that cluster proxy peers can start and connect to the server. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Changes** * Updated the `ClusterProxy` `spec.apiServer` default to include a trailing `/` when omitted, aligning operator behavior with the Kubernetes in-cluster API URL. * **Documentation** * Refreshed the `ClusterProxySpec.apiServer` API reference to reflect the trailing `/` default. * **Tests** * Improved end-to-end coverage with a dynamically provisioned management URL, more robust readiness polling, and enhanced `ClusterProxy` validation. * **Chores** * Updated the end-to-end test Go configuration and CI to use the e2e-specific Go settings/toolchain. <!-- 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 |