|
1 | 1 | # Netbird |
2 | 2 | Helm chart for installing Netbird in Kubernetes. |
3 | 3 |
|
| 4 | + |
4 | 5 | ## Helm Values |
5 | 6 | Reference for all available Helm values. |
6 | 7 |
|
| 8 | + |
| 9 | +### Global |
| 10 | +Global configuration for all deployments |
| 11 | + |
7 | 12 | | Name | Description | Value | |
8 | 13 | | ----------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------ | |
9 | | -| **global** | Global settings for all deployments (overrides for each deployment supported) | | |
10 | 14 | | global.revisionHistoryLimit | Number of retained replica sets to allow rollback | `2` | |
11 | 15 | | global.nodeSelector | Pod node selector labels | `{}` | |
12 | 16 | | global.annotations | Pod annotations | `{}` | |
13 | 17 | | global.tolerations | Pod tolerations | `[]` | |
14 | 18 | | global.affinity | Pod affinity | `{}` | |
15 | 19 | | global.resources | Pod resources | `{}` | |
16 | | -| **management** | Settings for the management deployment | | |
17 | | -| management.enabled | Create the mangement deployment | `true` | |
18 | | -| management.env | Environment variables (stored as a secret) | `{}` | |
19 | | -| management.config | The `management.json` configuration file (stored as a secret) | `""` | |
20 | | -| management.storage.enabled | Enable persistent storage | `false` | |
21 | | -| management.storage.size | Persistent volume size | `1Gi` | |
22 | | -| management.storage.selector | Additional labels to match for the PVC | `{}` | |
23 | | -| management.storage.dataSource | Custom data source for the PVC | `{}` | |
24 | | -| management.storage.storageClass | Persistent volume storage class | `""` | |
25 | | -| management.storage.accessModes | Persistent volume access modes | `["ReadWriteMany"]` | |
26 | | -| management.storage.existingClaim | Use an existing PVC which must be created beforehand | `""` | |
27 | | -| management.storage.subPath | The subdirectory of the volume to mount in the containers | `""` | |
28 | | -| management.image.repository | Image repository | `netbirdio/management` | |
29 | | -| management.image.pullPolicy | Image pull policy | `IfNotPresent` | |
30 | | -| management.image.tag | Image tag | `""` | |
31 | | -| management.service.type | Service type | `ClusterIP` | |
32 | | -| management.service.annotations | Service annotations | `{}` | |
33 | | -| management.service.httpPort | Port for HTTP traffic | `80` | |
34 | | -| management.service.grpcPort | Port for GRPC traffic | `33073` | |
35 | | -| **signal** | Settings for the signal deployment | | |
36 | | -| signal.enabled | Create the signal deployment | `true` | |
37 | | -| signal.image.repository | Image repository | `netbirdio/signal` | |
38 | | -| signal.image.pullPolicy | Image pull policy | `IfNotPresent` | |
39 | | -| signal.image.tag | Image tag | `""` | |
40 | | -| signal.service.type | Service type | `ClusterIP` | |
41 | | -| signal.service.annotations | Service annotations | `{}` | |
42 | | -| signal.service.grpcPort | Port for GRPC traffic | `80` | |
43 | | -| **relay** | Settings for the relay deployment | | |
44 | | -| relay.enabled | Create the relay deployment | `true` | |
45 | | -| relay.env | Environment variables (stored as a secret) | `{}` | |
46 | | -| relay.image.repository | Image repository | `netbirdio/relay` | |
47 | | -| relay.image.pullPolicy | Image pull policy | `IfNotPresent` | |
48 | | -| relay.image.tag | Image tag | `""` | |
49 | | -| relay.service.type | Service type | `ClusterIP` | |
50 | | -| relay.service.annotations | Service annotations | `{}` | |
51 | | -| relay.service.httpPort | Port for HTTP traffic | `80` | |
52 | | -| **dashboard** | Settings for the dashboard deployment | | |
| 20 | + |
| 21 | + |
| 22 | +### Server |
| 23 | +Configuration for the `server` deployment. |
| 24 | + |
| 25 | +| Name | Description | Value | |
| 26 | +| ----------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------ | |
| 27 | +| server.enabled | Create the mangement deployment | `true` | |
| 28 | +| server.config | The `config.yaml` configuration file (stored as a secret) | `""` | |
| 29 | +| server.storage.enabled | Enable persistent storage | `false` | |
| 30 | +| server.storage.size | Persistent volume size | `1Gi` | |
| 31 | +| server.storage.selector | Additional labels to match for the PVC | `{}` | |
| 32 | +| server.storage.dataSource | Custom data source for the PVC | `{}` | |
| 33 | +| server.storage.storageClass | Persistent volume storage class | `""` | |
| 34 | +| server.storage.accessModes | Persistent volume access modes | `["ReadWriteMany"]` | |
| 35 | +| server.storage.existingClaim | Use an existing PVC which must be created beforehand | `""` | |
| 36 | +| server.storage.subPath | The subdirectory of the volume to mount in the containers | `""` | |
| 37 | +| server.image.repository | Image repository | `netbirdio/management` | |
| 38 | +| server.image.pullPolicy | Image pull policy | `IfNotPresent` | |
| 39 | +| server.image.tag | Image tag | `""` | |
| 40 | +| server.service.type | Service type | `ClusterIP` | |
| 41 | +| server.service.annotations | Service annotations | `{}` | |
| 42 | +| server.service.httpPort | Port for HTTP traffic | `8080` | |
| 43 | +| server.service.stunPort | Port for STUN traffic | `3478` | |
| 44 | + |
| 45 | + |
| 46 | +### Dashboard |
| 47 | +Configuration for the `dashboard` deployment. |
| 48 | + |
| 49 | +| Name | Description | Value | |
| 50 | +| ----------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------ | |
53 | 51 | | dashboard.enabled | Create the dashboard deployment | `true` | |
54 | 52 | | dashboard.env | Environment variables (stored as a secret) | `{}` | |
55 | 53 | | dashboard.image.repository | Image repository | `netbirdio/dashboard` | |
56 | 54 | | dashboard.image.pullPolicy | Image pull policy | `IfNotPresent` | |
57 | 55 | | dashboard.image.tag | Image tag | `2.25.0` | |
58 | 56 | | dashboard.service.type | Service type | `ClusterIP` | |
59 | 57 | | dashboard.service.annotations | Service annotations | `{}` | |
60 | | -| dashboard.service.httpPort | Port for HTTP traffic | `80` | |
| 58 | +| dashboard.service.httpPort | Port for HTTP traffic | `8081` | |
0 commit comments