mirror of
https://github.com/YuzuZensai/netbird-kubernetes-operator.git
synced 2026-09-13 10:49:15 +00:00
dca7782571
Bumps [github.com/netbirdio/netbird](https://github.com/netbirdio/netbird) from 0.66.3 to 0.66.4. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/netbirdio/netbird/releases">github.com/netbirdio/netbird's releases</a>.</em></p> <blockquote> <h2>v0.66.4</h2> <h2>Release Notes for v0.66.4</h2> <h3>What's New</h3> <h4>Management Improvements</h4> <ul> <li> <p>Create a <strong>shallow copy of the account when buffering</strong> to improve memory safety and performance.<br /> <a href="https://redirect.github.com/netbirdio/netbird/pull/5572">netbirdio/netbird#5572</a></p> </li> <li> <p>Set <strong>network map components by default</strong> and optimize <strong>memory usage</strong>.<br /> <a href="https://redirect.github.com/netbirdio/netbird/pull/5575">netbirdio/netbird#5575</a></p> </li> </ul> <h4>Self-Hosted Improvements</h4> <ul> <li>Removed <strong>extra proxy domain instructions</strong> from the getting started guide to simplify setup.<br /> <a href="https://redirect.github.com/netbirdio/netbird/pull/5573">netbirdio/netbird#5573</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/netbirdio/netbird/compare/v0.66.3...v0.66.4">https://github.com/netbirdio/netbird/compare/v0.66.3...v0.66.4</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/netbirdio/netbird/commit/b5489d4986e6131f663ba24e330cbb3af4b92580"><code>b5489d4</code></a> [management] set components network map by default and optimize memory usage ...</li> <li><a href="https://github.com/netbirdio/netbird/commit/7a23c57cf8157f1c62619e68c6c104202c58a96b"><code>7a23c57</code></a> [self-hosted] Remove extra proxy domain from getting started (<a href="https://redirect.github.com/netbirdio/netbird/issues/5573">#5573</a>)</li> <li><a href="https://github.com/netbirdio/netbird/commit/11f891220e2ee5b1395e33a2e7a3672cd07f4bef"><code>11f8912</code></a> [management] create a shallow copy of the account when buffering (<a href="https://redirect.github.com/netbirdio/netbird/issues/5572">#5572</a>)</li> <li>See full diff in <a href="https://github.com/netbirdio/netbird/compare/v0.66.3...v0.66.4">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
NetBird Kubernetes Operator
For easily provisioning access to Kubernetes resources using NetBird.
https://github.com/user-attachments/assets/5472a499-e63d-4301-a513-ad84cfe5ca7b
Description
This operator easily provides NetBird access on Kubernetes clusters, allowing users to access internal resources directly.
Getting Started
Prerequisites
- (Recommended) helm version 3+
- kubectl version v1.11.3+.
- Access to a Kubernetes v1.11.3+ cluster.
- (Recommended) Cert Manager.
Deployment
- Add helm repository.
helm repo add netbirdio https://netbirdio.github.io/kubernetes-operator
- (Recommended) Install cert-manager for k8s API to communicate with the NetBird operator.
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.17.0/cert-manager.yaml
- Add NetBird API token
kubectl create namespace netbird
kubectl -n netbird create secret generic netbird-mgmt-api-key --from-literal=NB_API_KEY=$(cat ~/nb-pat.secret)
- (Recommended) Create a
values.yamlfile, checkhelm show values netbirdio/kubernetes-operatorfor more info. - Install using
helm install --create-namespace -f values.yaml -n netbird netbird-operator netbirdio/kubernetes-operator. - (Recommended) Check pod status using
kubectl get pods -n netbird. - (Optional) Create an
exposed-nginx.yamlfile to create a Nginx service for testing. - (Optional) Apply the Nginx service:
kubectl apply -f exposed-nginx.yaml
Learn more about the values.yaml options here and Granting controller access to NetBird Management.
Uninstallation
Important
Most operator resources are annotated with finalizers, attempting to delete the namespace will result in hanged deletion.
- (If ingress mode is enabled) Remove all instances of
netbird.io/exposeannotation on Services. - Run
helm uninstall -n netbird netbird-operator. - Wait for all deletion jobs to finish.
Version
We have developed and executed tests against Kubernetes v1.31, but it should work with most recent Kubernetes version.
Latest operator version: v0.1.1.
Tested against:
| Distribution | Test status | Kubernetes Version |
|---|---|---|
| Google GKE | Pass | 1.31.5 |
| AWS EKS | Pass | 1.31 |
| Azure AKS | Not tested | N/A |
| OpenShift | Not tested | N/A |
We would love community feedback to improve the test matrix. Please submit a PR with your test results.
Usage
Check the usage of usage.md and examples.
Contributing
Prerequisites
To be able to develop this project, you need to have the following tools installed:
- Git.
- Make.
- Go programming language.
- Docker CE.
- Kubernetes cluster (v1.16+). KIND is recommended.
- Kubebuilder.
Running tests
Running unit tests
make test
Running E2E tests
kind create cluster # If not already created, you can check with `kind get clusters`
make test-e2e