From 27a406e029050ab86ce523499acd5279e0bbef44 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 30 Jul 2025 16:54:49 +0100 Subject: [PATCH 1/5] feat: Add a landing page for NGINX Gateway Fabric This commit adds a landing page for NGINX Gateway Fabric. Custom landing pages allow us to draw a reader's attention towards the documentation they would find most useful as both a prospective or returning user, such as evergreen reference material. --- content/ngf/_index.md | 63 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 61 insertions(+), 2 deletions(-) diff --git a/content/ngf/_index.md b/content/ngf/_index.md index 88824442a..b939402a1 100644 --- a/content/ngf/_index.md +++ b/content/ngf/_index.md @@ -1,11 +1,70 @@ --- +# The title is the product name title: NGINX Gateway Fabric +# The URL is the base of the deployed path, becoming "docs.nginx.com//" url: /nginx-gateway-fabric/ -cascade: +# The cascade directive applies its nested parameters down the page tree until overwritten +cascade: + # The logo file is resolved from the theme, in the folder /static/images/icons/ logo: NGINX-Gateway-Fabric-product-icon.png nd-banner: enabled: true type: deprecation start-date: 2025-05-30 md: /_banners/ngf-2.0-release.md ---- \ No newline at end of file +# The subtitle displays directly underneath the heading of a given page +nd-subtitle: Implement the Gateway API across hybrid and multi-cloud Kubernetes environments with a secure, fast, and reliable NGINX data plane. +# Indicates that this is a custom landing page +nd-landing-page: true +# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this +nd-content-type: landing-page +# Intended for internal catalogue and search, case sensitive: +# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit +nd-product: NGF +--- + +## About + +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. + +For a list of supported Gateway API resources and features, see the [Gateway API Compatibility]({{< ref "/ngf/overview/gateway-api-compatibility.md" >}}) documentation. + +## Featured content + +{{}} + {{}} + {{}} + Use kind to quickly deploy and test a NGINX Gateway Fabric cluster. + {{}} + {{}} + Choose how to deploy NGINX Gateway Fabric in production. + {{}} + {{}} + Review the changes from the latest releases. + {{}} + {{}} +{{}} + +## Design + + +## More information + +{{}} + +{{}} + {{}} + View how much of the Gateway API NGINX Gateway Fabric supports. + {{}} + {{}} + Check which versions of NGINX Gateway Fabric match the API. + {{}} + {{}} + Create simple rules for directing network traffic. + {{}} + {{}} + Encrypt traffic between pods using a BackendTLSPolicy. + {{}} +{{}} + +{{}} \ No newline at end of file From a6ef6c786b1f367204acc89b6a21c4dbacebec87 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 6 Aug 2025 16:54:59 +0100 Subject: [PATCH 2/5] feat: Add architecture information --- content/ngf/_index.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/content/ngf/_index.md b/content/ngf/_index.md index b939402a1..e6bc95f1a 100644 --- a/content/ngf/_index.md +++ b/content/ngf/_index.md @@ -47,6 +47,15 @@ For a list of supported Gateway API resources and features, see the [Gateway API ## Design +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. + +When a new Gateway resource is provisioned, it dynamically creates and manages a corresponding NGINX data plane Deployment and Service. + +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. + +This design enables centralized management of multiple Gateways while ensuring that each NGINX instance stays aligned with the cluster’s current configuration. + +For more information, see the [Gateway architecture]({{< ref "/ngf/overview/gateway-architecture.md" >}}) topic. ## More information From 63a92f88525eb63b64bf479bb81b332802cc1d3b Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 6 Aug 2025 17:00:37 +0100 Subject: [PATCH 3/5] Update content/ngf/_index.md Co-authored-by: yar --- content/ngf/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/ngf/_index.md b/content/ngf/_index.md index e6bc95f1a..96263507b 100644 --- a/content/ngf/_index.md +++ b/content/ngf/_index.md @@ -25,7 +25,7 @@ nd-product: NGF ## About -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. +NGINX Gateway Fabric provides an implementation of the [Gateway API](https://gateway-api.sigs.k8s.io/) using [NGINX Open Source or NGINX Plus](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. For a list of supported Gateway API resources and features, see the [Gateway API Compatibility]({{< ref "/ngf/overview/gateway-api-compatibility.md" >}}) documentation. From 082f44c5cab7c18e24bf7b4fa49e58b2e29ebb88 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Wed, 6 Aug 2025 17:01:14 +0100 Subject: [PATCH 4/5] feat: Update NGINX noun --- content/ngf/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/ngf/_index.md b/content/ngf/_index.md index 96263507b..e6bc95f1a 100644 --- a/content/ngf/_index.md +++ b/content/ngf/_index.md @@ -25,7 +25,7 @@ nd-product: NGF ## About -NGINX Gateway Fabric provides an implementation of the [Gateway API](https://gateway-api.sigs.k8s.io/) using [NGINX Open Source or NGINX Plus](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. +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. For a list of supported Gateway API resources and features, see the [Gateway API Compatibility]({{< ref "/ngf/overview/gateway-api-compatibility.md" >}}) documentation. From 9063511264e4a42493302e1f99aab40305930c56 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 7 Aug 2025 14:32:49 +0100 Subject: [PATCH 5/5] feat: Update traffic security example --- content/ngf/_index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/ngf/_index.md b/content/ngf/_index.md index e6bc95f1a..3a43d8d79 100644 --- a/content/ngf/_index.md +++ b/content/ngf/_index.md @@ -69,10 +69,10 @@ For more information, see the [Gateway architecture]({{< ref "/ngf/overview/gate Check which versions of NGINX Gateway Fabric match the API. {{}} {{}} - Create simple rules for directing network traffic. + Create simple rules for directing network traffic with HTTPRoute resources. {{}} - {{}} - Encrypt traffic between pods using a BackendTLSPolicy. + {{}} + Implement HTTPS with Let's Encrypt to secure client-server communication. {{}} {{}}