sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-09-17 12:29:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add NetBird client compatibility to the operator support matrix (#961)

Browse Source 
* docs: add NetBird client compatibility to the operator support matrix

Add a "NetBird client compatibility" section to the Kubernetes operator
support matrix. Each operator release is built and tested against a
specific NetBird release and deploys that exact, digest-pinned client by
default, so a default install runs the supported combination. Document the
current pairing (operator v0.8.0 with NetBird v0.72.4), a table of tested
clients for recent releases, and that overriding routingClientImage is
neither supported nor tested.

Also replace an em dash in the Kubernetes compatibility section with two
plain sentences.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: ask for NetBird client version in operator issue reports

Address CodeRabbit review: the compatibility section makes the client
version part of the supported combination, so the reporting checklist now
asks for the NetBird client version and any routingClientImage override.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Bruno Mercier Costa
2026-09-09 16:23:34 +02:00
committed by GitHub
co-authored by Claude Opus 4.8
parent 1e79a0c72b
commit b15c34d353
1 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pages/help/support-matrix/kubernetes-operator.mdx
+16 -2
View File
@@ -5,7 +5,7 @@ export const description =
## Kubernetes compatibility
The NetBird Kubernetes operator targets the Kubernetes minor versions that are currently receiving patch releases from upstream. The [Kubernetes release policy](https://kubernetes.io/releases/) keeps release branches active for the three most recent minor versions, with roughly one year of patch support each — the operator tracks that same window.
The NetBird Kubernetes operator targets the Kubernetes minor versions that are currently receiving patch releases from upstream. The [Kubernetes release policy](https://kubernetes.io/releases/) keeps release branches active for the three most recent minor versions, with roughly one year of patch support each. The operator tracks that same window.
In practice this means the operator avoids depending on Kubernetes APIs or features that are not yet available across every supported minor version. When upstream drops a minor version from patch support, the operator may begin adopting capabilities that became generally available during that version's lifetime.
@@ -13,6 +13,20 @@ In practice this means the operator avoids depending on Kubernetes APIs or featu
The operator is developed against the latest NetBird control-plane release. Older control-plane versions may continue to work, but compatibility is not actively verified outside the current release.
## NetBird client compatibility
Each operator release is built and tested against a specific NetBird release, and it deploys that exact NetBird client by default. The current operator release, `v0.8.0`, is tested and supported with NetBird `v0.72.4`. Newer NetBird client releases may work, but they are not tested against the operator and are not officially supported.
| NetBird Kubernetes operator | Tested NetBird client |
|---|---|
| `v0.8.0` | `v0.72.4` |
| `v0.7.0` | `v0.72.4` |
| `v0.6.0` | `v0.71.4` |
| `v0.5.0` | `v0.71.2` |
| `v0.4.0`, `v0.4.1` | `v0.70.4` |
Each release pins the client image to its tested version by digest, so a default install already runs the supported combination. Operator `v0.8.0` deploys `ghcr.io/netbirdio/netbird:0.72.4`. Overriding the image with `routingClientImage` in the Helm chart values can be done, but is neither supported nor tested.
## Reporting compatibility issues
If you hit a problem on a supported combination, see [Report bugs and issues](/help/report-bug-issues). Include your operator version, Kubernetes version (`kubectl version`), and NetBird control-plane version.
If you hit a problem on a supported combination, see [Report bugs and issues](/help/report-bug-issues). Include your operator version, Kubernetes version (`kubectl version`), NetBird control-plane version, and the NetBird client version, along with any `routingClientImage` override you have set.