Skip to content

Commit 6bc90a8

Browse files
kevin85421sjbermanADubhlaoich
authored
[Doc] Update Helm chart instructions to avoid UX friction when using Kind (#1281)
For kind clusters, NodePort services require extra configuration and LoadBalancer services need a third-party controller like MetalLB for external IP assignment. However, the Helm chart creates a LoadBalancer service by default. Therefore, the --wait flag will hang until timeout. The guide running-on-kind.md asks users to create a Kind cluster by running the make create-kind-cluster command. However, the command neither sets the extraPortMappings Kind configs nor installs MetalLB, so users cannot use NodePort and LoadBalancer directly after running the command. This PR suggests users disable the creation of NodePort / LoadBalancer Kubernetes service, and uses the port-forwarding command from the running-on-kind.md guide. --------- Co-authored-by: Saylor Berman <s.berman@f5.com> Co-authored-by: Alan Dooley <ADubhlaoich@users.noreply.github.com>
1 parent 394aaa5 commit 6bc90a8

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

site/content/installation/running-on-kind.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ make create-kind-cluster
2525

2626
Follow the [installation](./how-to/installation/installation.md) instructions to deploy NGINX Gateway Fabric on your Kind cluster.
2727

28+
{{<note>}} For `kind` clusters, NodePort services require [extra configuration](https://kind.sigs.k8s.io/docs/user/configuration/#nodeport-with-port-mappings) and LoadBalancer services need [a third-party controller](https://kind.sigs.k8s.io/docs/user/loadbalancer/) like MetalLB for external IP assignment. However, the Helm chart creates a LoadBalancer service by default. To avoid this, you can disable service creation by adding `--set service.create=false` to your Helm command and use the port-forwarding command below instead to try out the examples. {{</note>}}
29+
2830
## Access NGINX Gateway Fabric
2931

3032
Forward local ports 8080 and 8443 to ports 80 and 443 of the nginx-gateway Pod:
@@ -33,8 +35,8 @@ Forward local ports 8080 and 8443 to ports 80 and 443 of the nginx-gateway Pod:
3335
kubectl -n nginx-gateway port-forward <pod-name> 8080:80 8443:443
3436
```
3537

36-
> Note: NGINX will not listen on any ports until you configure a
37-
> [Gateway](https://gateway-api.sigs.k8s.io/api-types/gateway/#gateway) resource with a valid listener.
38+
{{<note>}} NGINX will not listen on any ports until you configure a [Gateway](https://gateway-api.sigs.k8s.io/api-types/gateway/#gateway) resource with a valid listener. {{</note>}}
39+
3840

3941
## Use NGINX Gateway Fabric
4042

0 commit comments

Comments
 (0)