Skip to content

Commit aca9134

Browse files
Add ingress2gateway information in Getting Started guide (#1056)
* Add ingress2gateway information in Getting Started guide Co-authored-by: Saloni Choudhary <[email protected]>
1 parent 17366e3 commit aca9134

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

content/ngf/get-started.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -554,8 +554,39 @@ URI: /tea
554554
Request ID: 1b5c8f3a4532ea7d7510cf14ffeb27af
555555
```
556556

557+
## Migrate from NGINX Ingress Controller
558+
559+
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.
560+
561+
The ingress2gateway tool is a Kubernetes SIG project for converting Ingress resources to Gateway API resources. It supports multiple Ingress providers, including NGINX Ingress Controller.
562+
563+
{{< call-out "important" >}}
564+
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.
565+
{{< /call-out >}}
566+
567+
### Use ingress2gateway
568+
569+
To convert your existing NGINX Ingress resources to Gateway API resources that work with NGINX Gateway Fabric:
570+
571+
572+
First, [install the ingress2gateway tool](https://github.com/kubernetes-sigs/ingress2gateway?tab=readme-ov-file#installation).
573+
574+
Then run the conversion command for the NGINX provider:
575+
576+
```shell
577+
ingress2gateway print --providers=nginx --input-file=<your-ingress-file> > gateway-api-resources.yaml
578+
```
579+
580+
This tool will analyze your Ingress resources from the input file and output the equivalent Gateway API resources to a file named `gateway-api-resources.yaml`. Finally, review the generated Gateway API resources in the output file and apply them to your cluster:
581+
582+
```shell
583+
kubectl apply -f gateway-api-resources.yaml
584+
```
585+
586+
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).
587+
557588
## Next steps
558589

559590
- [Install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}), for additional ways to install NGINX Gateway Fabric
560591
- [Traffic management]({{< ref "/ngf/traffic-management/" >}}), for more in-depth traffic management configuration
561-
- [How-to guides]({{< ref "/ngf/how-to/" >}}), for configuring your cluster
592+
- [How-to guides]({{< ref "/ngf/how-to/" >}}), for configuring your cluster

0 commit comments

Comments
 (0)