Skip to content

Add ingress2gateway information in Getting Started guide #1056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+29 −0
Open

Add ingress2gateway information in Getting Started guide #1056

Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4606f8a
Add ingress2gateway information in Getting Started guide
sarthyparty Sep 3, 2025
97f6f6d
fix comments
sarthyparty Sep 3, 2025
5806218
clean doc
sarthyparty Sep 3, 2025
77864ae
fix conversion command
sarthyparty Sep 3, 2025
fb7219f
address doc comments
sarthyparty Sep 4, 2025
b77b28a
Merge branch 'main' into ingress2gateway-info
sarthyparty Sep 4, 2025
d4307bc
remove print command without redirect
sarthyparty Sep 4, 2025
7ad545b
Update content/ngf/get-started.md
sarthyparty Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions content/ngf/get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,6 +554,35 @@ 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](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 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.
{{< /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?tab=readme-ov-file#installation).

2. Run the conversion command for NGINX provider:
```shell
ingress2gateway print --providers=nginx --input-file=<your-ingress-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
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).

## Next steps

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