From 7be9e7f0e172d982f0913c215a6cabde7b894761 Mon Sep 17 00:00:00 2001 From: kaihsun Date: Sun, 26 Nov 2023 07:38:54 +0000 Subject: [PATCH 1/8] update --- deploy/helm-chart/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/deploy/helm-chart/README.md b/deploy/helm-chart/README.md index 2801de2a99..eff05f8135 100644 --- a/deploy/helm-chart/README.md +++ b/deploy/helm-chart/README.md @@ -71,6 +71,12 @@ nginx-gateway namespace (with optional `--create-namespace` flag - you can omit ```shell helm install my-release oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-namespace --wait -n nginx-gateway + +# 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. To avoid this, you can disable service creation using the below command and use port-forwarding +# as described in the `running-on-kind.md` guide instead to try out the examples: +helm install my-release oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-namespace --wait -n nginx-gateway --set service.create=false ``` This will install the latest stable release. To install the latest version from the `main` branch, specify the From 8da1f021f5098287b479065498c0b3b0d4868de5 Mon Sep 17 00:00:00 2001 From: kaihsun Date: Mon, 27 Nov 2023 22:22:13 +0000 Subject: [PATCH 2/8] update --- deploy/helm-chart/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/deploy/helm-chart/README.md b/deploy/helm-chart/README.md index eff05f8135..ac32162daf 100644 --- a/deploy/helm-chart/README.md +++ b/deploy/helm-chart/README.md @@ -71,17 +71,18 @@ nginx-gateway namespace (with optional `--create-namespace` flag - you can omit ```shell helm install my-release oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-namespace --wait -n nginx-gateway - -# 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. To avoid this, you can disable service creation using the below command and use port-forwarding -# as described in the `running-on-kind.md` guide instead to try out the examples: -helm install my-release oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-namespace --wait -n nginx-gateway --set service.create=false ``` This will install the latest stable release. To install the latest version from the `main` branch, specify the `--version 0.0.0-edge` flag when installing. +> **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 port-forwarding +> as described in the [Running on `kind`](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/running-on-kind.md) guide instead to try out the examples. + ### Installing the Chart via Sources #### Pulling the Chart From 856043e1416900a0f9f95077c3125067660dedcf Mon Sep 17 00:00:00 2001 From: kaihsun Date: Mon, 27 Nov 2023 22:23:43 +0000 Subject: [PATCH 3/8] update --- deploy/helm-chart/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy/helm-chart/README.md b/deploy/helm-chart/README.md index ac32162daf..78283fda07 100644 --- a/deploy/helm-chart/README.md +++ b/deploy/helm-chart/README.md @@ -81,7 +81,7 @@ This will install the latest stable release. To install the latest version from > 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 port-forwarding -> as described in the [Running on `kind`](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/running-on-kind.md) guide instead to try out the examples. +> as described in the [running-on-kind.md](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/running-on-kind.md) guide instead to try out the examples. ### Installing the Chart via Sources From e093ac50809118b7c0b314d8115f5577e7dae635 Mon Sep 17 00:00:00 2001 From: kaihsun Date: Wed, 29 Nov 2023 17:53:07 +0000 Subject: [PATCH 4/8] fix lint --- deploy/helm-chart/README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/deploy/helm-chart/README.md b/deploy/helm-chart/README.md index 78283fda07..b0d84a779c 100644 --- a/deploy/helm-chart/README.md +++ b/deploy/helm-chart/README.md @@ -78,10 +78,13 @@ This will install the latest stable release. To install the latest version from > **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. +> 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 port-forwarding -> as described in the [running-on-kind.md](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/running-on-kind.md) guide instead to try out the examples. +> 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 port-forwarding as described in the [running-on-kind.md](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/running-on-kind.md) +> guide instead to try out the examples. ### Installing the Chart via Sources From 0ce6bea0db9d393501d22c991bd04eeac4f71a70 Mon Sep 17 00:00:00 2001 From: kaihsun Date: Thu, 30 Nov 2023 05:36:53 +0000 Subject: [PATCH 5/8] update --- deploy/helm-chart/README.md | 10 ---------- site/content/installation/running-on-kind.md | 9 +++++++++ 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/deploy/helm-chart/README.md b/deploy/helm-chart/README.md index b0d84a779c..2801de2a99 100644 --- a/deploy/helm-chart/README.md +++ b/deploy/helm-chart/README.md @@ -76,16 +76,6 @@ helm install my-release oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --cr This will install the latest stable release. To install the latest version from the `main` branch, specify the `--version 0.0.0-edge` flag when installing. -> **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 port-forwarding as described in the [running-on-kind.md](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/running-on-kind.md) -> guide instead to try out the examples. - ### Installing the Chart via Sources #### Pulling the Chart diff --git a/site/content/installation/running-on-kind.md b/site/content/installation/running-on-kind.md index 01e6cf7346..48a1bb4ddf 100644 --- a/site/content/installation/running-on-kind.md +++ b/site/content/installation/running-on-kind.md @@ -25,6 +25,15 @@ 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. + ## Access NGINX Gateway Fabric Forward local ports 8080 and 8443 to ports 80 and 443 of the nginx-gateway Pod: From a5333e86818e49f16f26accd68dd128adc550b1d Mon Sep 17 00:00:00 2001 From: kaihsun Date: Thu, 30 Nov 2023 18:07:10 +0000 Subject: [PATCH 6/8] update --- site/content/installation/running-on-kind.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/site/content/installation/running-on-kind.md b/site/content/installation/running-on-kind.md index 48a1bb4ddf..dd6656accd 100644 --- a/site/content/installation/running-on-kind.md +++ b/site/content/installation/running-on-kind.md @@ -25,14 +25,7 @@ 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. +{{}}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.{{}} ## Access NGINX Gateway Fabric @@ -42,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 From 1c8d7e305f0d8c09b0b582e70775c7202e260a17 Mon Sep 17 00:00:00 2001 From: Kai-Hsun Chen Date: Thu, 30 Nov 2023 13:43:34 -0800 Subject: [PATCH 7/8] Update site/content/installation/running-on-kind.md Co-authored-by: Saylor Berman --- site/content/installation/running-on-kind.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/installation/running-on-kind.md b/site/content/installation/running-on-kind.md index dd6656accd..55d3fec2b1 100644 --- a/site/content/installation/running-on-kind.md +++ b/site/content/installation/running-on-kind.md @@ -25,7 +25,7 @@ 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. 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.{{}} +{{}}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 From cf6489ceaee13e4e6f1239308d4022ddcbf33899 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Mon, 4 Dec 2023 12:12:36 +0000 Subject: [PATCH 8/8] Apply suggestions from code review --- site/content/installation/running-on-kind.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/content/installation/running-on-kind.md b/site/content/installation/running-on-kind.md index 55d3fec2b1..38f97fc918 100644 --- a/site/content/installation/running-on-kind.md +++ b/site/content/installation/running-on-kind.md @@ -25,7 +25,7 @@ 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.{{}} +{{}} 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 @@ -35,7 +35,7 @@ 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 ``` -{{}}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