Repository files navigation

NGINX Gateway Fabric is an open-source project that provides an implementation oftheGateway API usingNGINX as the data plane. The goal ofthis project is to implement the core Gateway APIs --Gateway,GatewayClass,HTTPRoute,GRPCRoute,TCPRoute,TLSRoute,andUDPRoute -- to configure an HTTP or TCP/UDP load balancer, reverse-proxy, or API gateway for applications runningon Kubernetes. NGINX Gateway Fabric supports a subset of the Gateway API.

For a list of supported Gateway API resources and features, seetheGateway API Compatibility doc.

Learn about ourdesign principles andarchitecture.

NGINX Gateway Fabric usesNGINX Agent to configure NGINX.

1. Get started using a kind cluster.
2. Install NGINX Gateway Fabric.
3. Deploy variousexamples.
4. Follow instructions for common use cases such asrouting andsecuring traffic, ormonitoring your cluster.

You can find the comprehensive NGINX Gateway Fabric user documentation on theNGINX Documentation website.

We publish NGINX Gateway Fabric releases on GitHub. Seeourreleases page.

The latest release is2.0.2.

The edge version is useful for experimenting with new features that are not yet published in a release. To use, choosetheedge version built from thelatest commitfrom the main branch.

The table below summarizes the options regarding the images, manifests, documentation and examples and gives your linksto the correct versions:

NGF uses semantic versioning for its releases. For more information, seehttps://semver.org.

Major version zero(0.Y.Z) is reserved for development, anything MAY change at any time. The public API is not stable.

The features that will go into the next release are reflected in thecorrespondingmilestone. Refer totheIssue Lifecycle document for information on issue creation and assignment to releases.

The following table lists the software versions NGINX Gateway Fabric supports.

We generate SBOMs for the binaries and the Docker image.

The SBOMs for the binaries are available in the releases page. The SBOMs are generatedusingsyft and are available in SPDX format.

The SBOM for the Docker image is available intheGitHub Containerrepository. The SBOM is generated usingsyft and stored as an attestation in theimage manifest.

For example to retrieve the SBOM forlinux/amd64 and analyze it usinggrype youcan run the following command:

docker buildx imagetools inspect ghcr.io/nginx/nginx-gateway-fabric:edge --format'{{ json (index .SBOM "linux/amd64").SPDX }}'| grype

For troubleshooting help, see theTroubleshooting document.

We’d like to hear your feedback! If you experience issues with our Gateway Controller, pleaseopen a bug inGitHub. If you have any suggestions or enhancement requests, pleaseopen an idea on GitHub discussions. You cancontact us directly on theNGINX Community Forum.

Every Tuesday at 9:30AM Pacific / 5:30PM GMT

For the meeting link, updates, agenda, and meeting notes, check the calendar below:

NGINX Gateway Fabric Meeting Calendar

If you have a use case for NGINX Gateway Fabric that the project can't quite meet yet, bugs, problems, success stories, or just want to be more involved with the project, come by and say hi!

Please read ourContributing guide if you'd like to contribute to the project.

If your team needs dedicated support for NGINX Gateway Fabric in your environment, or you would like to leverage ouradvanced NGINX Plus features, you can reach outhere.

To try NGINX Gateway Fabric with NGINX Plus, you can start your free30-day trial, then follow theinstallation guide for installing with NGINX Plus.