Skip to content

Commit fdeec8f

Browse files
JTorreGADubhlaoich
andauthored
docs: update architecture doc (#1295)
* docs: update architecture doc * chore: update architecture description --------- Co-authored-by: Alan Dooley <ADubhlaoich@users.noreply.github.com>
1 parent ba2b986 commit fdeec8f

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

site/content/overview/gateway-architecture.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Gateway Architecture"
3-
description: "Learn about the architecture and design principles of F5 NGINX Gateway Fabric."
3+
description: "Learn about the architecture and design principles of NGINX Gateway Fabric."
44
weight: 100
55
toc: true
66
docs: "DOCS-000"
@@ -13,11 +13,13 @@ The intended audience for this information is primarily the two following groups
1313

1414
The reader needs to be familiar with core Kubernetes concepts, such as pods, deployments, services, and endpoints. For an understanding of how NGINX itself works, you can read the ["Inside NGINX: How We Designed for Performance & Scale"](https://www.nginx.com/blog/inside-nginx-how-we-designed-for-performance-scale/) blog post.
1515

16-
## What is NGINX Gateway Fabric?
16+
## NGINX Gateway Fabric Overview
1717

18-
NGINX Gateway Fabric is a Kubernetes cluster component that uses Gateway API Resources to configure an HTTP load balancer with NGINX as its data plane.
18+
NGINX Gateway Fabric is an open source project that 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 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.
1919

20-
{{< note >}} To learn more about the Gateway API, you can read the [official Kubernetes documentation](https://gateway-api.sigs.k8s.io/). {{< /note >}}
20+
For a list of supported Gateway API resources and features, see the [Gateway API Compatibility]({{< relref "/overview/gateway-api-compatibility.md" >}}) documentation.
21+
22+
We have more information regarding our [design principles](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/docs/developer/design-principles.md) in the project's GitHub repository.
2123

2224
## NGINX Gateway Fabric at a high level
2325

0 commit comments

Comments
 (0)