|
1 | 1 | ---
|
| 2 | +# The title is the product name |
2 | 3 | title: NGINX Gateway Fabric
|
| 4 | +# The URL is the base of the deployed path, becoming "docs.nginx.com/<url>/<other-pages>" |
3 | 5 | url: /nginx-gateway-fabric/
|
4 |
| -cascade: |
| 6 | +# The cascade directive applies its nested parameters down the page tree until overwritten |
| 7 | +cascade: |
| 8 | + # The logo file is resolved from the theme, in the folder /static/images/icons/ |
5 | 9 | logo: NGINX-Gateway-Fabric-product-icon.png
|
6 | 10 | nd-banner:
|
7 | 11 | enabled: true
|
8 | 12 | type: deprecation
|
9 | 13 | start-date: 2025-05-30
|
10 | 14 | md: /_banners/ngf-2.0-release.md
|
11 |
| ---- |
| 15 | +# The subtitle displays directly underneath the heading of a given page |
| 16 | +nd-subtitle: Implement the Gateway API across hybrid and multi-cloud Kubernetes environments with a secure, fast, and reliable NGINX data plane. |
| 17 | +# Indicates that this is a custom landing page |
| 18 | +nd-landing-page: true |
| 19 | +# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this |
| 20 | +nd-content-type: landing-page |
| 21 | +# Intended for internal catalogue and search, case sensitive: |
| 22 | +# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit |
| 23 | +nd-product: NGF |
| 24 | +--- |
| 25 | + |
| 26 | +## About |
| 27 | + |
| 28 | +NGINX Gateway Fabric provides an implementation of the [Gateway API](https://gateway-api.sigs.k8s.io/) using [NGINX](https://nginx.org/) as the data plane. The goal of the project is to implement the core Gateway APIs needed to configure an HTTP or TCP/UDP load balancer, reverse proxy, or API gateway for Kubernetes applications. |
| 29 | + |
| 30 | +For a list of supported Gateway API resources and features, see the [Gateway API Compatibility]({{< ref "/ngf/overview/gateway-api-compatibility.md" >}}) documentation. |
| 31 | + |
| 32 | +## Featured content |
| 33 | + |
| 34 | +{{<card-layout>}} |
| 35 | + {{<card-section showAsCards="true" isFeaturedSection="true">}} |
| 36 | + {{<card title="Get started" titleUrl="/nginx-gateway-fabric/get-started">}} |
| 37 | + Use kind to quickly deploy and test a NGINX Gateway Fabric cluster. |
| 38 | + {{</card>}} |
| 39 | + {{<card title="Deploy NGINX Gateway Fabric" titleUrl="/nginx-gateway-fabric/install">}} |
| 40 | + Choose how to deploy NGINX Gateway Fabric in production. |
| 41 | + {{</card>}} |
| 42 | + {{<card title="Changelog" titleUrl="/nginx-gateway-fabric/changelog">}} |
| 43 | + Review the changes from the latest releases. |
| 44 | + {{</card>}} |
| 45 | + {{</card-section>}} |
| 46 | +{{</card-layout>}} |
| 47 | + |
| 48 | +## Design |
| 49 | + |
| 50 | +NGINX Gateway Fabric separates the control plane and data plane into distinct deployments. The control plane interacts with the Kubernetes API, watching for Gateway API resources. |
| 51 | + |
| 52 | +When a new Gateway resource is provisioned, it dynamically creates and manages a corresponding NGINX data plane Deployment and Service. |
| 53 | + |
| 54 | +Each NGINX data plane pod consists of an NGINX container integrated with [NGINX Agent](https://github.com/nginx/agent). The control plane translates Gateway API resources into NGINX configurations and sends these configurations to the agent to ensure consistent traffic management. |
| 55 | + |
| 56 | +This design enables centralized management of multiple Gateways while ensuring that each NGINX instance stays aligned with the cluster’s current configuration. |
| 57 | + |
| 58 | +For more information, see the [Gateway architecture]({{< ref "/ngf/overview/gateway-architecture.md" >}}) topic. |
| 59 | + |
| 60 | +## More information |
| 61 | + |
| 62 | +{{<card-layout>}} |
| 63 | + |
| 64 | +{{<card-section showAsCards="true">}} |
| 65 | + {{<card title="Gateway API compatibility" titleUrl="/nginx-gateway-fabric/overview/gateway-api-compatibility/">}} |
| 66 | + View how much of the Gateway API NGINX Gateway Fabric supports. |
| 67 | + {{</card>}} |
| 68 | + {{<card title="Technical specifications" titleUrl="/nginx-gateway-fabric/reference/technical-specifications/">}} |
| 69 | + Check which versions of NGINX Gateway Fabric match the API. |
| 70 | + {{</card>}} |
| 71 | + {{<card title="Routing traffic to applications" titleUrl="/nginx-gateway-fabric/traffic-management/basic-routing/">}} |
| 72 | + Create simple rules for directing network traffic with HTTPRoute resources. |
| 73 | + {{</card>}} |
| 74 | + {{<card title="Secure traffic using Let's Encrypt and cert-manager" titleUrl="/nginx-gateway-fabric/traffic-security/integrate-cert-manager/">}} |
| 75 | + Implement HTTPS with Let's Encrypt to secure client-server communication. |
| 76 | + {{</card>}} |
| 77 | +{{</card-section>}} |
| 78 | + |
| 79 | +{{</card-layout>}} |
0 commit comments