Update documentation with refactored resources (#204)

This updates the documentation and examples to use the new resources. It
also adds automatic documentation creation for the api reference.

Signed-off-by: Philip Laine <philip.laine@gmail.com>
This commit is contained in:
Philip Laine
2026-04-24 16:22:04 +02:00
committed by GitHub
parent fe715ae40c
commit dd054d50ec
19 changed files with 642 additions and 464 deletions
+42
View File
@@ -0,0 +1,42 @@
# Getting Started
## Prerequisites
- A NetBird [service user access token](https://docs.netbird.io/manage/public-api).
- Access to Kubernetes cluster.
- Kubectl and Helm installed locally.
## Steps
Add the Helm repository.
```sh
helm repo add netbirdio https://netbirdio.github.io/kubernetes-operator
```
Install cert-manager, it is recommended so the Kubernetes API can communicate with the operator's admission webhooks. Skip this step if you already have cert-manager installed.
```sh
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.17.0/cert-manager.yaml
```
Create the NetBird namespace and API secret. The operator needs a NetBird personal access token to authenticate with the NetBird Management API.
```sh
kubectl create namespace netbird
kubectl -n netbird create secret generic netbird-mgmt-api-key --from-literal=NB_API_KEY=${ACCESS_TOKEN}
```
Install the Netbird operator.
```sh
helm install netbird-operator netbirdio/kubernetes-operator --create-namespace --namespace netbird
```
Verify the installation. All pods should be in a `Running` state before continuing.
```sh
kubectl get pods -n netbird
```
Once the operator is running, see the [usage guide](/docs/usage.md) to start exposing services to your NetBird network.