Skip to content

Improve API key documentation for helm chart #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve API key documentation for helm chart #412

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/pages/how-to/kubernetes-operator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/
3. Add NetBird API token. You can create a PAT by following the steps [here](/how-to/access-netbird-public-api#creating-a-service-user).
```shell
kubectl create namespace netbird
kubectl -n netbird create secret generic netbird-mgmt-api-key --from-literal=NB_API_KEY=$(cat ~/nb-pat.secret)
kubectl -n netbird create secret generic netbird-mgmt-api-key --from-literal=NB_API_KEY=<API KEY>
```
<Note>
Replace `~/nb-pat.secret` with your NetBird API key.
Replace `<API KEY>` with your NetBird API key.
</Note>

4. (Recommended) Create a [`values.yaml`](https://github.com/netbirdio/kubernetes-operator/blob/main/examples/ingress/values.yaml) file, check `helm show values netbirdio/kubernetes-operator` for more info.
Expand All @@ -44,7 +44,9 @@ ingress:
enabled: true

netbirdAPI:
keyFromSecret: "netbird-mgmt-api-key"
keyFromSecret:
name: "netbird-mgmt-api-key"
key: NB_API_KEY
```
5. Install using helm install:
```shell
Expand Down