Skip to content

Commit 317be26

Browse files
committed
Add example steps
1 parent b8b268e commit 317be26

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,16 @@ This operator easily provides NetBird access on Kubernetes clusters, allowing us
2727
helm repo add netbirdio https://netbirdio.github.io/kubernetes-operator
2828
```
2929
2. (Recommended) Install [cert-manager](https://cert-manager.io/docs/installation/#default-static-install).
30-
3. (Recommended) Create a values.yaml file, check `helm show values netbirdio/kubernetes-operator` for more info.
30+
```sh
31+
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.17.0/cert-manager.yaml
32+
```
33+
3. (Recommended) Create a [`values.yaml`](examples/ingress/values.yaml) file, check `helm show values netbirdio/kubernetes-operator` for more info.
3134
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:
37+
```sh
38+
kubectl apply -f exposed-nginx.yaml
39+
```
3240

3341
> Learn more about the values.yaml options [here](helm/kubernetes-operator/values.yaml) and [Granting controller access to NetBird Management](docs/usage.md#granting-controller-access-to-netbird-management).
3442
#### Using install.yaml

examples/ingress/values.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,9 @@ ingress:
99
- All
1010

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

0 commit comments

Comments
 (0)