Skip to content

Commit 345cee5

Browse files
committed
Extend example steps
1 parent 317be26 commit 345cee5

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,20 @@ This operator easily provides NetBird access on Kubernetes clusters, allowing us
2626
```sh
2727
helm repo add netbirdio https://netbirdio.github.io/kubernetes-operator
2828
```
29-
2. (Recommended) Install [cert-manager](https://cert-manager.io/docs/installation/#default-static-install).
29+
2. (Recommended) Install [cert-manager](https://cert-manager.io/docs/installation/#default-static-install) for k8s API to communicate with the NetBird operator.
3030
```sh
3131
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.17.0/cert-manager.yaml
3232
```
33-
3. (Recommended) Create a [`values.yaml`](examples/ingress/values.yaml) file, check `helm show values netbirdio/kubernetes-operator` for more info.
34-
4. Install using `helm install --create-namespace -f values.yaml -n netbird netbird-operator netbirdio/kubernetes-operator`.
35-
5. (Optional) Create an [`exposed-nginx.yaml`](examples/ingress/exposed-nginx.yaml) file to create a Nginx service for testing.
36-
6. (Optional) Apply the Nginx service:
33+
3. Add NetBird API token
34+
```shell
35+
kubectl create namespace netbird
36+
kubectl -n netbird create secret generic netbird-mgmt-api-key --from-literal=NB_API_KEY=$(cat ~/nb-pat.secret)
37+
```
38+
4. (Recommended) Create a [`values.yaml`](examples/ingress/values.yaml) file, check `helm show values netbirdio/kubernetes-operator` for more info.
39+
5. Install using `helm install --create-namespace -f values.yaml -n netbird netbird-operator netbirdio/kubernetes-operator`.
40+
6. (Recommended) Check pod status using `kubectl get pods -n netbird`.
41+
6. (Optional) Create an [`exposed-nginx.yaml`](examples/ingress/exposed-nginx.yaml) file to create a Nginx service for testing.
42+
7. (Optional) Apply the Nginx service:
3743
```sh
3844
kubectl apply -f exposed-nginx.yaml
3945
```

examples/ingress/values.yaml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@ ingress:
22
enabled: true
33
router:
44
enabled: true
5-
policies:
6-
default:
7-
name: Kubernetes Default Policy
8-
sourceGroups:
9-
- All
5+
# policies:
6+
# default:
7+
# name: Kubernetes Default Policy
8+
# sourceGroups:
9+
# - All
1010

1111
netbirdAPI:
1212
# Replace with valid NetBird Service Account token (PAT)
1313
# https://docs.netbird.io/how-to/access-netbird-public-api#creating-an-access-token
14-
#key: "nbp_m0LM9ZZvDUzF8fpY50iChDOTxJgKFM3DIqmZ"
14+
#key: "nbp_m0LM9yZvDUzF8fpY20iChDOTxJgKFM3DIqmZ"
1515
# Use keyFromSecret instead of plain text secret
16-
keyFromSecret: "netbird-mgmt-api-key"
17-
16+
keyFromSecret: "netbird-mgmt-api-key"

0 commit comments

Comments
 (0)