Skip to content

NGINX Gateway Fabric provides an implementation for the Gateway API using NGINX as the data plane.

License

Notifications You must be signed in to change notification settings

Jcahilltorre/nginx-gateway-fabric

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenSSF Scorecard FOSSA Status

NGINX Gateway Fabric

NGINX Gateway Fabric is an open-source project that provides an implementation of the Gateway API using NGINX as the data plane. The goal of this project is to implement the core Gateway APIs -- Gateway, GatewayClass, HTTPRoute, TCPRoute, TLSRoute, and UDPRoute -- to configure an HTTP or TCP/UDP load balancer, reverse-proxy, or API gateway for applications running on Kubernetes. NGINX Gateway Fabric supports a subset of the Gateway API.

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

Learn about our design principles and architecture.

Getting Started

  1. Quick Start on a kind cluster.
  2. Install NGINX Gateway Fabric.
  3. Build an NGINX Gateway Fabric container image from source or use a pre-built image available on GitHub Container Registry.
  4. Deploy various examples.
  5. Read our How-to guides.

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

NGINX Gateway Fabric Releases

We publish NGINX Gateway Fabric releases on GitHub. See our releases page.

The latest release is 1.0.0.

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

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

Version Description Installation Manifests Documentation and Examples
Latest release For production use Manifests. Documentation. Examples.
Edge For experimental use and latest features Manifests. Documentation. Examples.

Versioning

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

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

Release Planning and Development

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

Technical Specifications

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

NGINX Gateway Fabric Gateway API Kubernetes NGINX OSS
Edge 1.0.0 1.23+ 1.25.3
1.0.0 0.8.1 1.23+ 1.25.2
0.6.0 0.8.0 1.23+ 1.25.2
0.5.0 0.7.1 1.21+ 1.25.x *
0.4.0 0.7.1 1.21+ 1.25.x *
0.3.0 0.6.2 1.21+ 1.23.x *
0.2.0 0.5.1 1.21+ 1.21.x *
0.1.0 0.5.0 1.19+ 1.21.3

*the installation manifests use the minor version of NGINX container image (e.g. 1.25) and the patch version is not specified. This means that the latest available patch version is used.

SBOM (Software Bill of Materials)

We generate SBOMs for the binaries and the Docker image.

Binaries

The SBOMs for the binaries are available in the releases page. The SBOMs are generated using syft and are available in SPDX format.

Docker Images

The SBOM for the Docker image is available in the GitHub Container repository. The SBOM is generated using syft and stored as an attestation in the image manifest.

For example to retrieve the SBOM for linux/amd64 and analyze it using grype you can run the following command:

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

Troubleshooting

For troubleshooting help, see the Troubleshooting document.

Contacts

We’d like to hear your feedback! If you experience issues with our Gateway Controller, please open a bug in GitHub. If you have any suggestions or enhancement requests, please open an idea on GitHub discussions. You can contact us directly via [email protected] or on the NGINX Community Slack in the #nginx-gateway-fabric channel.

Contributing

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

Support

NGINX Gateway Fabric is not covered by any support contract.

About

NGINX Gateway Fabric provides an implementation for the Gateway API using NGINX as the data plane.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 94.4%
  • JavaScript 2.0%
  • Makefile 1.8%
  • Shell 0.7%
  • Mermaid 0.5%
  • Smarty 0.2%
  • Other 0.4%