YuzuZensai/netbird-kubernetes-operator
1
0
Fork 0
mirror of https://github.com/YuzuZensai/netbird-kubernetes-operator.git synced 2026-09-13 18:59:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
69 Commits 1 Branch 0 Tags
ad42dfe3e5fd8049bb781d349394e1f3c4682eed
T
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
dependabot[bot]GitHubdependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 ad42dfe3e5 Bump github.com/onsi/ginkgo/v2 from 2.21.0 to 2.28.1 (#132) 
Bumps [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo) from
2.21.0 to 2.28.1.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/onsi/ginkgo/releases">github.com/onsi/ginkgo/v2's
releases</a>.</em></p>
<blockquote>
<h2>v2.28.1</h2>
<h2>2.28.1</h2>
<p>Update all dependencies. This auto-updated the required version of Go
to 1.24, consistent with the fact that Go 1.23 has been out of support
for almost six months.</p>
<h2>v2.28.0</h2>
<h2>2.28.0</h2>
<p>Ginkgo's SemVer filter now supports filtering multiple components by
SemVer version:</p>
<pre lang="go"><code>It(&quot;should work in a specific version range
(1.0.0, 2.0.0) and third-party dependency redis in [8.0.0, ~)&quot;,
SemVerConstraint(&quot;&gt;= 3.2.0&quot;),
ComponentSemVerConstraint(&quot;redis&quot;, &quot;&gt;= 8.0.0&quot;)
func() {
// This test will only run when version is between 1.0.0 (exclusive) and
2.0.0 (exclusive) and redis version is &gt;= 8.0.0
})
</code></pre>
<p>can be filtered in or out with an invocation like:</p>
<pre lang="bash"><code>ginkgo --sem-ver-filter=&quot;2.1.1,
redis=8.2.0&quot;
</code></pre>
<p>Huge thanks to <a
href="https://github.com/Icarus9913"><code>@​Icarus9913</code></a> for
working on this!</p>
<h2>v2.27.5</h2>
<h2>2.27.5</h2>
<h3>Fixes</h3>
<p>Don't make a new formatter for each GinkgoT(); that's just silly and
uses precious memory</p>
<h2>v2.27.4</h2>
<h2>2.27.4</h2>
<h3>Fixes</h3>
<ul>
<li>CurrentTreeConstructionNodeReport: fix for nested container nodes
[59bc751]</li>
</ul>
<h2>v2.27.3</h2>
<h2>2.27.3</h2>
<h3>Fixes</h3>
<p>report exit result in case of failure [1c9f356]
fix data race [ece19c8]</p>
<h2>v2.27.2</h2>
<h2>2.27.2</h2>
<h3>Fixes</h3>
<ul>
<li>inline automaxprocs to simplify dependencies; this will be removed
when Go 1.26 comes out [a69113a]</li>
</ul>
<h3>Maintenance</h3>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md">github.com/onsi/ginkgo/v2's
changelog</a>.</em></p>
<blockquote>
<h2>2.28.1</h2>
<p>Update all dependencies. This auto-updated the required version of Go
to 1.24, consistent with the fact that Go 1.23 has been out of support
for almost six months.</p>
<h2>2.28.0</h2>
<p>Ginkgo's SemVer filter now supports filtering multiple components by
SemVer version:</p>
<pre lang="go"><code>It(&quot;should work in a specific version range
(1.0.0, 2.0.0) and third-party dependency redis in [8.0.0, ~)&quot;,
SemVerConstraint(&quot;&gt;= 3.2.0&quot;),
ComponentSemVerConstraint(&quot;redis&quot;, &quot;&gt;= 8.0.0&quot;)
func() {
// This test will only run when version is between 1.0.0 (exclusive) and
2.0.0 (exclusive) and redis version is &gt;= 8.0.0
})
</code></pre>
<p>can be filtered in or out with an invocation like:</p>
<pre lang="bash"><code>ginkgo --sem-ver-filter=&quot;2.1.1,
redis=8.2.0&quot;
</code></pre>
<p>Huge thanks to <a
href="https://github.com/Icarus9913"><code>@​Icarus9913</code></a> for
working on this!</p>
<h2>2.27.5</h2>
<h3>Fixes</h3>
<p>Don't make a new formatter for each GinkgoT(); that's just silly and
uses precious memory</p>
<h2>2.27.4</h2>
<h3>Fixes</h3>
<ul>
<li>CurrentTreeConstructionNodeReport: fix for nested container nodes
[59bc751]</li>
</ul>
<h2>2.27.3</h2>
<h3>Fixes</h3>
<p>report exit result in case of failure [1c9f356]
fix data race [ece19c8]</p>
<h2>2.27.2</h2>
<h3>Fixes</h3>
<ul>
<li>inline automaxprocs to simplify dependencies; this will be removed
when Go 1.26 comes out [a69113a]</li>
</ul>
<h3>Maintenance</h3>
<ul>
<li>Fix syntax errors and typo [a99c6e0]</li>
<li>Fix paragraph position error [f993df5]</li>
</ul>
<h2>2.27.1</h2>
<h3>Fixes</h3>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/onsi/ginkgo/commit/5d1d628ac86668c8f944c8c491c3d1ab86b3bed4"><code>5d1d628</code></a>
v2.28.1</li>
<li><a
href="https://github.com/onsi/ginkgo/commit/676f985d26d9b5d02f73086760883f7086bb5386"><code>676f985</code></a>
update test mu language</li>
<li><a
href="https://github.com/onsi/ginkgo/commit/8032100d256f25df9be61f2623fc244c9ea0cafb"><code>8032100</code></a>
appease go vet</li>
<li><a
href="https://github.com/onsi/ginkgo/commit/41ca8077223910d4d20e099204a8520057ab8b82"><code>41ca807</code></a>
bump dependencies</li>
<li><a
href="https://github.com/onsi/ginkgo/commit/2b2305b02aad8f5316b0bfcaabe5b9789d988db6"><code>2b2305b</code></a>
v2.28.0</li>
<li><a
href="https://github.com/onsi/ginkgo/commit/71d2d89adc9387d4f4fc579438b5631d9180d687"><code>71d2d89</code></a>
feat: support component semantic version filtering</li>
<li><a
href="https://github.com/onsi/ginkgo/commit/8cbbcb4709d306183de94f0699dd92affeb6f5b0"><code>8cbbcb4</code></a>
Fix doclink for ginkgo run</li>
<li><a
href="https://github.com/onsi/ginkgo/commit/a92830749ce9b1271ffac08abce793ae937fe9d4"><code>a928307</code></a>
v2.27.5</li>
<li><a
href="https://github.com/onsi/ginkgo/commit/0d0e96db305b01ce8642008053b857363ca87ecb"><code>0d0e96d</code></a>
don't make a new formatter for each GinkgoT(); that's just silly and
uses pre...</li>
<li><a
href="https://github.com/onsi/ginkgo/commit/867ce95f5142649695406f751f883c99ea45c0d5"><code>867ce95</code></a>
v2.27.4</li>
<li>Additional commits viewable in <a
href="https://github.com/onsi/ginkgo/compare/v2.21.0...v2.28.1">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=github.com/onsi/ginkgo/v2&package-manager=go_modules&previous-version=2.21.0&new-version=2.28.1)](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>
2026-03-11 12:48:11 +01:00
.github
Cleanup workflows and pin action versions (#118)
2026-03-11 11:24:17 +01:00
api/v1
Add optional privileged mode to NBRoutingPeerSpec (#92)
2026-03-03 08:29:52 +01:00
cmd
Fix flaky e2e tests (#120)
2026-03-10 21:31:54 +01:00
crds
Bump chart version to 0.1.10 (#39)
2025-05-02 19:37:36 +02:00
docs
Add support for running as a init sidecar container (#99)
2026-02-11 15:20:52 +03:00
examples
Add support for running as a init sidecar container (#99)
2026-02-11 15:20:52 +03:00
hack
Add initial version with help and admission controller (#1)
2025-01-29 22:44:09 +01:00
helm
fix: rendering of protocols and ports in NBPolicy (#96)
2026-03-03 08:58:50 +01:00
internal
Update Netbird dependency and Golang version (#112)
2026-03-03 10:31:38 +01:00
manifests
Add ingress feature to controller (#5)
2025-03-06 09:57:45 +01:00
test
Fix flaky e2e tests (#120)
2026-03-10 21:31:54 +01:00
.dockerignore
Add initial version with help and admission controller (#1)
2025-01-29 22:44:09 +01:00
.gitignore
Add initial version with help and admission controller (#1)
2025-01-29 22:44:09 +01:00
.golangci.yml
Update Golang CI Lint to the latest version (#113)
2026-02-27 19:07:58 +01:00
CONTRIBUTOR_LICENSE_AGREEMENT.md
Add CLA (#15)
2025-03-19 15:12:18 +01:00
Dockerfile
Update Netbird dependency and Golang version (#112)
2026-03-03 10:31:38 +01:00
Dockerfile.kubectl
Add missing envsubst utility (#101) (#102)
2026-03-03 08:30:27 +01:00
Dockerfile.release
Add initial version with help and admission controller (#1)
2025-01-29 22:44:09 +01:00
go.mod
Bump github.com/onsi/ginkgo/v2 from 2.21.0 to 2.28.1 (#132)
2026-03-11 12:48:11 +01:00
go.sum
Bump github.com/onsi/ginkgo/v2 from 2.21.0 to 2.28.1 (#132)
2026-03-11 12:48:11 +01:00
LICENSE
Initial commit
2025-01-24 13:01:03 +01:00
Makefile
Remove goreleaser and fix helm packaging (#6)
2025-03-05 09:03:04 +01:00
PROJECT
Add ingress feature to controller (#5)
2025-03-06 09:57:45 +01:00
README.md
Add uninstallation doc to README
2025-08-08 14:14:25 +03:00

README.md

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

  1. Add helm repository.
helm repo add netbirdio https://netbirdio.github.io/kubernetes-operator
  1. (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
  1. 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)
  1. (Recommended) Create a values.yaml file, check helm show values netbirdio/kubernetes-operator for more info.
  2. Install using helm install --create-namespace -f values.yaml -n netbird netbird-operator netbirdio/kubernetes-operator.
  3. (Recommended) Check pod status using kubectl get pods -n netbird.
  4. (Optional) Create an exposed-nginx.yaml file to create a Nginx service for testing.
  5. (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.

  1. (If ingress mode is enabled) Remove all instances of netbird.io/expose annotation on Services.
  2. Run helm uninstall -n netbird netbird-operator.
  3. 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:

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
Reference in New Issue View Git Blame Copy Permalink
S
Description
Kubernetes operator for Netbird
Readme BSD-3-Clause
1.2 MiB
Languages
Go 97.8%
Makefile 1.2%
Go Template 0.9%
Dockerfile 0.1%