Skip to content

Commit 4606f8a

Browse files
author
Sarthak Agrawal
committed
Add ingress2gateway information in Getting Started guide
1 parent 15ba053 commit 4606f8a

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

content/ngf/get-started.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -554,6 +554,38 @@ URI: /tea
554554
Request ID: 1b5c8f3a4532ea7d7510cf14ffeb27af
555555
```
556556

557+
## Migrating 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 tool to automatically convert your existing Ingress resources to Gateway API resources.
560+
561+
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.
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+
### Using ingress2gateway
568+
569+
To convert your existing NGINX Ingress resources to Gateway API resources that work with NGINX Gateway Fabric:
570+
571+
1. Install the ingress2gateway tool following the [installation instructions](https://github.com/kubernetes-sigs/ingress2gateway).
572+
573+
2. Run the conversion command for NGINX provider:
574+
```shell
575+
ingress2gateway --providers=nginx --input-file=<your-ingress-file>.yaml > output-file=gateway-api-resources.yaml
576+
```
577+
578+
3. Review the generated Gateway API resources and apply them to your cluster:
579+
```shell
580+
kubectl apply -f gateway-api-resources.yaml
581+
```
582+
583+
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).
584+
585+
{{< call-out "note" >}}
586+
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.
587+
{{< /call-out >}}
588+
557589
## Next steps
558590

559591
- [Install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}), for additional ways to install NGINX Gateway Fabric

0 commit comments

Comments
 (0)