Skip to content

Commit fc6b801

Browse files
committed
add extra labels example and link to full values
1 parent 1fa72db commit fc6b801

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/usage.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Usage
22

3-
## Provision pods with NetBird access
3+
## Provision pods with NetBird access using side-cars
44

55
1. Create a Setup Key in your [NetBird console](https://docs.netbird.io/how-to/register-machines-using-setup-keys#using-setup-keys).
66
1. Create a Secret object in the namespace where you need to provision NetBird access (secret name and field can be anything).
@@ -42,6 +42,12 @@ spec:
4242
...
4343
```
4444

45+
Since 0.27.0 NetBird supports extra DNS labels, which extends the DNS names that you can link to peers by grouping them and load balancing access using DNS round-robin. To enable this feature, add the following annotation to the pod:
46+
```yaml
47+
netbird.io/extra-dns-labels: "label1,label2"
48+
```
49+
With this setup, all peers with the same extra label would be used in a DNS round-robin fashion.
50+
4551
## Provisioning Networks (Ingress Functionality)
4652

4753
### Granting controller access to NetBird Management
@@ -69,7 +75,7 @@ ingress:
6975
cluster:
7076
name: kubernetes
7177
```
72-
78+
> Learn more about the values.yaml options [here](../helm/kubernetes-operator/values.yaml).
7379
### Exposing a Service
7480

7581
> [!IMPORTANT]

0 commit comments

Comments
 (0)