mirror of
https://github.com/outbackdingo/lark-netbird-helm-charts.git
synced 2026-01-27 10:19:34 +00:00
docs: fix markdown linting issues
This commit is contained in:
20
README.md
20
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
[](https://artifacthub.io/packages/search?repo=jaconi)
|
||||
|
||||
```
|
||||
```shell
|
||||
helm repo add jaconi https://charts.jaconi.io
|
||||
```
|
||||
|
||||
@@ -10,25 +10,25 @@ helm repo add jaconi https://charts.jaconi.io
|
||||
|
||||
Create a [kind](https://kind.sigs.k8s.io) cluster:
|
||||
|
||||
```
|
||||
```shell
|
||||
kind create cluster --config kind.yaml
|
||||
```
|
||||
|
||||
Install [MetalLB](https://metallb.universe.tf) in the created cluster:
|
||||
|
||||
```
|
||||
```shell
|
||||
kubectl apply -f https://raw.githubusercontent.com/metallb/metallb/v0.13.9/config/manifests/metallb-native.yaml
|
||||
```
|
||||
|
||||
Determine the kind IP range:
|
||||
|
||||
```
|
||||
```shell
|
||||
docker network inspect -f '{{ .IPAM.Config }}' kind
|
||||
```
|
||||
|
||||
Configure an IP address pool for MetalLB:
|
||||
|
||||
```
|
||||
```shell
|
||||
kubectl apply -f - << EOF
|
||||
apiVersion: metallb.io/v1beta1
|
||||
kind: IPAddressPool
|
||||
@@ -52,13 +52,13 @@ EOF
|
||||
|
||||
Start [Keycloak](https://www.keycloak.org):
|
||||
|
||||
```
|
||||
```shell
|
||||
docker compose up --detach
|
||||
```
|
||||
|
||||
Install the Helm charts for testing:
|
||||
|
||||
```
|
||||
```shell
|
||||
for f in */Chart.yaml; do
|
||||
chart=$(dirname $f)
|
||||
helm install --create-namespace --namespace $chart $chart $chart
|
||||
@@ -67,7 +67,7 @@ done
|
||||
|
||||
After changing things, update the Helm charts:
|
||||
|
||||
```
|
||||
```shell
|
||||
for f in */Chart.yaml; do
|
||||
chart=$(dirname $f)
|
||||
helm upgrade --namespace $chart $chart $chart
|
||||
@@ -78,12 +78,12 @@ done
|
||||
|
||||
Forward the NetBird management server to port `8081`:
|
||||
|
||||
```
|
||||
```shell
|
||||
kubectl port-forward -n netbird service/netbird-management 8081:80
|
||||
```
|
||||
|
||||
Forward the NetBird dashboard to port `8080`:
|
||||
|
||||
```
|
||||
```shell
|
||||
kubectl port-forward -n netbird-dashboard service/netbird-dashboard 8080:80
|
||||
```
|
||||
|
||||
@@ -14,15 +14,14 @@ certificate:
|
||||
issuerName: letsencrypt
|
||||
```
|
||||
|
||||
The resulting TLS certificate and private key will be passed to coturn via the `--cert` and `--pkey` flags. The settings
|
||||
`cert` and `pkey` will be ignored.
|
||||
The resulting TLS certificate and private key will be passed to coturn via the
|
||||
`--cert` and `--pkey` flags. The settings `cert` and `pkey` will be ignored.
|
||||
|
||||
## Traefik
|
||||
|
||||
When using [Traefik](https://traefik.io), a
|
||||
[IngressRouteTCP](https://doc.traefik.io/traefik/routing/providers/kubernetes-crd/#kind-ingressroutetcp) and a
|
||||
[IngressRouteUDP](https://doc.traefik.io/traefik/routing/providers/kubernetes-crd/#kind-ingressrouteudp) resource can be
|
||||
created by this chart:
|
||||
When using [Traefik](https://traefik.io), a [IngressRouteTCP](https://doc.traefik.io/traefik/routing/providers/kubernetes-crd/#kind-ingressroutetcp)
|
||||
and a [IngressRouteUDP](https://doc.traefik.io/traefik/routing/providers/kubernetes-crd/#kind-ingressrouteudp)
|
||||
resource can be created by this chart:
|
||||
|
||||
```yaml
|
||||
traefik:
|
||||
@@ -34,7 +33,8 @@ traefik:
|
||||
udp-tls: udp-tls
|
||||
```
|
||||
|
||||
When using the official Traefik Helm chart, the following (or similar) configuration is needed for Traefik:
|
||||
When using the official Traefik Helm chart, the following (or similar)
|
||||
configuration is needed for Traefik:
|
||||
|
||||
```yaml
|
||||
ports:
|
||||
|
||||
Reference in New Issue
Block a user