From 4606f8aac2d4e992248e9ea60fdfcec8b22db1f1 Mon Sep 17 00:00:00 2001 From: Sarthak Agrawal Date: Wed, 3 Sep 2025 11:26:25 -0700 Subject: [PATCH 1/7] Add ingress2gateway information in Getting Started guide --- content/ngf/get-started.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/content/ngf/get-started.md b/content/ngf/get-started.md index 48310cd99..438d02bba 100644 --- a/content/ngf/get-started.md +++ b/content/ngf/get-started.md @@ -554,6 +554,38 @@ URI: /tea Request ID: 1b5c8f3a4532ea7d7510cf14ffeb27af ``` +## Migrating from NGINX Ingress Controller + +If you're already using NGINX Ingress Controller and want to migrate to NGINX Gateway Fabric, you can use the ingress2gateway tool to automatically convert your existing Ingress resources to Gateway API resources. + +The ingress2gateway tool is a Kubernetes SIG project that helps convert Ingress resources to Gateway API resources. It supports various Ingress controllers, including NGINX Ingress Controller. + +{{< call-out "important" >}} +The ingress2gateway tool is a conversion utility that translates Ingress resources to Gateway API equivalents. It is not a complete end-to-end migration solution. You will need to manually review the converted resources, test functionality, and make additional configuration changes as needed for your specific environment. +{{< /call-out >}} + +### Using ingress2gateway + +To convert your existing NGINX Ingress resources to Gateway API resources that work with NGINX Gateway Fabric: + +1. Install the ingress2gateway tool following the [installation instructions](https://github.com/kubernetes-sigs/ingress2gateway). + +2. Run the conversion command for NGINX provider: + ```shell + ingress2gateway --providers=nginx --input-file=.yaml > output-file=gateway-api-resources.yaml + ``` + +3. Review the generated Gateway API resources and apply them to your cluster: + ```shell + kubectl apply -f gateway-api-resources.yaml + ``` + +For detailed information about NGINX-specific features and conversion options, see the [NGINX provider documentation](https://github.com/kubernetes-sigs/ingress2gateway/blob/main/pkg/i2gw/providers/nginx/README.md). + +{{< call-out "note" >}} +After conversion, you may need to adjust some configurations to take advantage of NGINX Gateway Fabric-specific features or to ensure compatibility with your existing setup. +{{< /call-out >}} + ## Next steps - [Install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}), for additional ways to install NGINX Gateway Fabric From 97f6f6dad99869dc09cadab69022791615856d3f Mon Sep 17 00:00:00 2001 From: Sarthak Agrawal Date: Wed, 3 Sep 2025 12:32:21 -0700 Subject: [PATCH 2/7] fix comments --- content/ngf/get-started.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/ngf/get-started.md b/content/ngf/get-started.md index 438d02bba..0eb0fe3bb 100644 --- a/content/ngf/get-started.md +++ b/content/ngf/get-started.md @@ -556,7 +556,7 @@ Request ID: 1b5c8f3a4532ea7d7510cf14ffeb27af ## Migrating from NGINX Ingress Controller -If you're already using NGINX Ingress Controller and want to migrate to NGINX Gateway Fabric, you can use the ingress2gateway tool to automatically convert your existing Ingress resources to Gateway API resources. +If you're already using NGINX Ingress Controller and want to migrate to NGINX Gateway Fabric, you can use the [ingress2gateway](https://github.com/kubernetes-sigs/ingress2gateway) tool to automatically convert your existing Ingress resources to Gateway API resources. The ingress2gateway tool is a Kubernetes SIG project that helps convert Ingress resources to Gateway API resources. It supports various Ingress controllers, including NGINX Ingress Controller. @@ -568,11 +568,11 @@ The ingress2gateway tool is a conversion utility that translates Ingress resourc To convert your existing NGINX Ingress resources to Gateway API resources that work with NGINX Gateway Fabric: -1. Install the ingress2gateway tool following the [installation instructions](https://github.com/kubernetes-sigs/ingress2gateway). +1. Install the ingress2gateway tool following the [installation instructions](https://github.com/kubernetes-sigs/ingress2gateway?tab=readme-ov-file#installation). 2. Run the conversion command for NGINX provider: ```shell - ingress2gateway --providers=nginx --input-file=.yaml > output-file=gateway-api-resources.yaml + ingress2gateway --providers=nginx --input-file= Date: Wed, 3 Sep 2025 12:33:54 -0700 Subject: [PATCH 3/7] clean doc --- content/ngf/get-started.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/content/ngf/get-started.md b/content/ngf/get-started.md index 0eb0fe3bb..4fcc72d43 100644 --- a/content/ngf/get-started.md +++ b/content/ngf/get-started.md @@ -572,13 +572,10 @@ To convert your existing NGINX Ingress resources to Gateway API resources that w 2. Run the conversion command for NGINX provider: ```shell - ingress2gateway --providers=nginx --input-file= ``` -3. Review the generated Gateway API resources and apply them to your cluster: - ```shell - kubectl apply -f gateway-api-resources.yaml - ``` +3. Review the generated Gateway API resources and apply them to your cluster For detailed information about NGINX-specific features and conversion options, see the [NGINX provider documentation](https://github.com/kubernetes-sigs/ingress2gateway/blob/main/pkg/i2gw/providers/nginx/README.md). From 77864aeaa0a796485e18dd2cd2f30e41ba4fff6f Mon Sep 17 00:00:00 2001 From: Sarthak Agrawal Date: Wed, 3 Sep 2025 12:52:06 -0700 Subject: [PATCH 4/7] fix conversion command --- content/ngf/get-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/ngf/get-started.md b/content/ngf/get-started.md index 4fcc72d43..c80b9a667 100644 --- a/content/ngf/get-started.md +++ b/content/ngf/get-started.md @@ -572,7 +572,7 @@ To convert your existing NGINX Ingress resources to Gateway API resources that w 2. Run the conversion command for NGINX provider: ```shell - ingress2gateway --providers=nginx --input-file= + ingress2gateway print --providers=nginx --input-file= ``` 3. Review the generated Gateway API resources and apply them to your cluster From fb7219febf3f8623e82a5dd92bf61fad9e993212 Mon Sep 17 00:00:00 2001 From: Sarthak Agrawal Date: Thu, 4 Sep 2025 10:52:37 -0700 Subject: [PATCH 5/7] address doc comments --- content/ngf/get-started.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/content/ngf/get-started.md b/content/ngf/get-started.md index c80b9a667..2299eefb3 100644 --- a/content/ngf/get-started.md +++ b/content/ngf/get-started.md @@ -558,7 +558,7 @@ Request ID: 1b5c8f3a4532ea7d7510cf14ffeb27af If you're already using NGINX Ingress Controller and want to migrate to NGINX Gateway Fabric, you can use the [ingress2gateway](https://github.com/kubernetes-sigs/ingress2gateway) tool to automatically convert your existing Ingress resources to Gateway API resources. -The ingress2gateway tool is a Kubernetes SIG project that helps convert Ingress resources to Gateway API resources. It supports various Ingress controllers, including NGINX Ingress Controller. +The ingress2gateway tool is a Kubernetes SIG project that helps convert Ingress resources to Gateway API resources. It supports various Ingress providers, including NGINX Ingress Controller. {{< call-out "important" >}} The ingress2gateway tool is a conversion utility that translates Ingress resources to Gateway API equivalents. It is not a complete end-to-end migration solution. You will need to manually review the converted resources, test functionality, and make additional configuration changes as needed for your specific environment. @@ -574,15 +574,18 @@ To convert your existing NGINX Ingress resources to Gateway API resources that w ```shell ingress2gateway print --providers=nginx --input-file= ``` + This command will analyze your Ingress resources and output the equivalent Gateway API resources to stdout. You can redirect the output to a file for review: + ```shell + ingress2gateway print --providers=nginx --input-file= > gateway-api-resources.yaml + ``` -3. Review the generated Gateway API resources and apply them to your cluster +3. Review the generated Gateway API resources in the output file and apply them to your cluster: + ```shell + kubectl apply -f gateway-api-resources.yaml + ``` For detailed information about NGINX-specific features and conversion options, see the [NGINX provider documentation](https://github.com/kubernetes-sigs/ingress2gateway/blob/main/pkg/i2gw/providers/nginx/README.md). -{{< call-out "note" >}} -After conversion, you may need to adjust some configurations to take advantage of NGINX Gateway Fabric-specific features or to ensure compatibility with your existing setup. -{{< /call-out >}} - ## Next steps - [Install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}), for additional ways to install NGINX Gateway Fabric From d4307bc391e380e26d5e8e95c847f2ecebd9b736 Mon Sep 17 00:00:00 2001 From: Sarthak Agrawal Date: Thu, 4 Sep 2025 11:17:39 -0700 Subject: [PATCH 6/7] remove print command without redirect --- content/ngf/get-started.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/content/ngf/get-started.md b/content/ngf/get-started.md index 2299eefb3..c441bfa80 100644 --- a/content/ngf/get-started.md +++ b/content/ngf/get-started.md @@ -571,13 +571,10 @@ To convert your existing NGINX Ingress resources to Gateway API resources that w 1. Install the ingress2gateway tool following the [installation instructions](https://github.com/kubernetes-sigs/ingress2gateway?tab=readme-ov-file#installation). 2. Run the conversion command for NGINX provider: - ```shell - ingress2gateway print --providers=nginx --input-file= - ``` - This command will analyze your Ingress resources and output the equivalent Gateway API resources to stdout. You can redirect the output to a file for review: ```shell ingress2gateway print --providers=nginx --input-file= > gateway-api-resources.yaml ``` + This command will analyze your Ingress resources and output the equivalent Gateway API resources to stdout. You can redirect the output to a file for review: 3. Review the generated Gateway API resources in the output file and apply them to your cluster: ```shell From 7ad545bd0758b06bc52d522d8ff6295de484948a Mon Sep 17 00:00:00 2001 From: Sarthak Agrawal <68310924+sarthyparty@users.noreply.github.com> Date: Fri, 5 Sep 2025 09:53:22 -0700 Subject: [PATCH 7/7] Update content/ngf/get-started.md Co-authored-by: bjee19 <139261241+bjee19@users.noreply.github.com> --- content/ngf/get-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/ngf/get-started.md b/content/ngf/get-started.md index c441bfa80..df7d61633 100644 --- a/content/ngf/get-started.md +++ b/content/ngf/get-started.md @@ -574,7 +574,7 @@ To convert your existing NGINX Ingress resources to Gateway API resources that w ```shell ingress2gateway print --providers=nginx --input-file= > gateway-api-resources.yaml ``` - This command will analyze your Ingress resources and output the equivalent Gateway API resources to stdout. You can redirect the output to a file for review: + This command will analyze your Ingress resources from the input file and output the equivalent Gateway API resources to a file named `gateway-api-resources.yaml` 3. Review the generated Gateway API resources in the output file and apply them to your cluster: ```shell