Skip to content
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

[Doc] Update Helm chart instructions to avoid UX friction when using Kind #1281

Merged
merged 9 commits into from
Dec 4, 2023
Merged

[Doc] Update Helm chart instructions to avoid UX friction when using Kind #1281

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7be9e7f
update
kevin85421 Nov 26, 2023
8da1f02
update
kevin85421 Nov 27, 2023
856043e
update
kevin85421 Nov 27, 2023
e093ac5
fix lint
kevin85421 Nov 29, 2023
0ce6bea
update
kevin85421 Nov 30, 2023
a5333e8
update
kevin85421 Nov 30, 2023
1c8d7e3
Update site/content/installation/running-on-kind.md
kevin85421 Nov 30, 2023
cf6489c
Apply suggestions from code review
ADubhlaoich Dec 4, 2023
a2abd4a
Merge branch 'main' into update-doc
sjberman Dec 4, 2023
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
6 changes: 4 additions & 2 deletions site/content/installation/running-on-kind.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ make create-kind-cluster

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

{{<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. Therefore, the `--wait` flag will hang until timeout. 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>}}
kevin85421 marked this conversation as resolved.
Show resolved Hide resolved

## Access NGINX Gateway Fabric

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

> 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>}}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>}}
sjberman marked this conversation as resolved.
Show resolved Hide resolved
ADubhlaoich marked this conversation as resolved.
Show resolved Hide resolved


## Use NGINX Gateway Fabric

Expand Down