Skip to content

Commit 64f140f

Browse files
authored
Merge branch 'main' into nic/landing-page
2 parents 278f30b + bb9796b commit 64f140f

File tree

4 files changed

+73
-4
lines changed

4 files changed

+73
-4
lines changed

.github/workflows/coveo.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ jobs:
7272
needs: generate-coveo-search-token
7373
steps:
7474
- name: Download Coveo search token
75-
uses: actions/download-artifact@v4
75+
uses: actions/download-artifact@v5
7676

7777
- name: View files
7878
run: ls -R

.github/workflows/linkchecker.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ env:
3232
--ignore-url ^https://oauth2.googleapis.com --ignore-url ^https://openidconnect.googleapis.com --ignore-url ^https://www.base64url.com/
3333
--ignore-url ^https://go.googlesource.com/ --ignore-url ^https://go.googlesource.com/sync --ignore-url ^https://linkerd.io/2.13/
3434
--ignore-url ^http://www.redirectpage.com/ --ignore-url ^https://www.gnu.org/ --ignore-url ^https://insert_your_tenant_name.console.ves.volterra.io/
35+
--ignore-url ^https://INSERT_YOUR_TENANT_NAME.console.ves.volterra.io
3536
--ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginx-ingress-controller/css
3637
--ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginxaas/azure/css
3738
--ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginx-gateway-fabric/css

.github/workflows/ossf_scorecard.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,6 @@ jobs:
5656

5757
# Upload the results to GitHub's code scanning dashboard.
5858
- name: Upload SARIF results to code scanning
59-
uses: github/codeql-action/upload-sarif@51f77329afa6477de8c49fc9c7046c15b9a4e79d # v3.29.5
59+
uses: github/codeql-action/upload-sarif@76621b61decf072c1cee8dd1ce2d2a82d33c17ed # v3.29.5
6060
with:
6161
sarif_file: results.sarif

content/ngf/_index.md

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,79 @@
11
---
2+
# The title is the product name
23
title: NGINX Gateway Fabric
4+
# The URL is the base of the deployed path, becoming "docs.nginx.com/<url>/<other-pages>"
35
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/
59
logo: NGINX-Gateway-Fabric-product-icon.png
610
nd-banner:
711
enabled: true
812
type: deprecation
913
start-date: 2025-05-30
1014
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

Comments
 (0)