From 394aaa51b1abcc25a51856d1d794f3d1a7ee5ab7 Mon Sep 17 00:00:00 2001 From: Sanath Kumar Date: Mon, 4 Dec 2023 06:54:54 -0800 Subject: [PATCH 1/2] docs: update the readme with correct compatibility doc link (#1322) docs: update the readme with correct compatibility doc --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d5f258180..f5e642949a 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ and `UDPRoute` -- to configure an HTTP or TCP/UDP load balancer, reverse-proxy, on Kubernetes. NGINX Gateway Fabric supports a subset of the Gateway API. For a list of supported Gateway API resources and features, see -the [Gateway API Compatibility](https://docs.nginx.com/nginx-gateway-fabric/gateway-api-compatibility/) doc. +the [Gateway API Compatibility](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-api-compatibility/) doc. Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture/). From 6bc90a88fd614e477d6df3cc1c04c916cbfbe845 Mon Sep 17 00:00:00 2001 From: Kai-Hsun Chen Date: Mon, 4 Dec 2023 07:03:04 -0800 Subject: [PATCH 2/2] [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 Co-authored-by: Alan Dooley --- site/content/installation/running-on-kind.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/site/content/installation/running-on-kind.md b/site/content/installation/running-on-kind.md index 01e6cf7346..38f97fc918 100644 --- a/site/content/installation/running-on-kind.md +++ b/site/content/installation/running-on-kind.md @@ -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. +{{}} 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. {{}} + ## Access NGINX Gateway Fabric 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: kubectl -n nginx-gateway port-forward 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. +{{}} 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. {{}} + ## Use NGINX Gateway Fabric