generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 101
feat: Add a landing page for NGINX Gateway Fabric #911
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
27a406e
feat: Add a landing page for NGINX Gateway Fabric
ADubhlaoich 8bd2c6d
Merge branch 'main' into ngf/landing-page
ADubhlaoich 4eada0d
Merge branch 'main' into ngf/landing-page
ADubhlaoich 8bb9351
Merge branch 'main' into ngf/landing-page
ADubhlaoich a6ef6c7
feat: Add architecture information
ADubhlaoich 63a92f8
Update content/ngf/_index.md
ADubhlaoich 082f44c
feat: Update NGINX noun
ADubhlaoich 9a84ffd
Merge branch 'main' into ngf/landing-page
ADubhlaoich 9063511
feat: Update traffic security example
ADubhlaoich 65b62a4
Merge branch 'main' into ngf/landing-page
ADubhlaoich File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,79 @@ | ||
--- | ||
# The title is the product name | ||
title: NGINX Gateway Fabric | ||
# The URL is the base of the deployed path, becoming "docs.nginx.com/<url>/<other-pages>" | ||
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 | ||
--- | ||
# 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 | ||
|
||
{{<card-layout>}} | ||
{{<card-section showAsCards="true" isFeaturedSection="true">}} | ||
{{<card title="Get started" titleUrl="/nginx-gateway-fabric/get-started">}} | ||
Use kind to quickly deploy and test a NGINX Gateway Fabric cluster. | ||
{{</card>}} | ||
{{<card title="Deploy NGINX Gateway Fabric" titleUrl="/nginx-gateway-fabric/install">}} | ||
Choose how to deploy NGINX Gateway Fabric in production. | ||
{{</card>}} | ||
{{<card title="Changelog" titleUrl="/nginx-gateway-fabric/changelog">}} | ||
Review the changes from the latest releases. | ||
{{</card>}} | ||
{{</card-section>}} | ||
{{</card-layout>}} | ||
|
||
## 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 | ||
|
||
{{<card-layout>}} | ||
|
||
{{<card-section showAsCards="true">}} | ||
{{<card title="Gateway API compatibility" titleUrl="/nginx-gateway-fabric/overview/gateway-api-compatibility/">}} | ||
View how much of the Gateway API NGINX Gateway Fabric supports. | ||
{{</card>}} | ||
{{<card title="Technical specifications" titleUrl="/nginx-gateway-fabric/reference/technical-specifications/">}} | ||
Check which versions of NGINX Gateway Fabric match the API. | ||
{{</card>}} | ||
{{<card title="Routing traffic to applications" titleUrl="/nginx-gateway-fabric/traffic-management/basic-routing/">}} | ||
Create simple rules for directing network traffic. | ||
{{</card>}} | ||
{{<card title="Secure backend traffic" titleUrl="/nginx-gateway-fabric/traffic-security/secure-backend/">}} | ||
Encrypt traffic between pods using a BackendTLSPolicy. | ||
ADubhlaoich marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{{</card>}} | ||
{{</card-section>}} | ||
|
||
{{</card-layout>}} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.