Skip to content

Commit 5eaacdc

Browse files
authored
Merge pull request #2191 from david-martin/api-gateway-wording
Clarify different between API Gateway and Gateway API
2 parents 1764e45 + 8296590 commit 5eaacdc

File tree

2 files changed

+54
-16
lines changed

2 files changed

+54
-16
lines changed

site-src/faq.md

Lines changed: 36 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,25 +41,47 @@
4141
for implementations to use.
4242

4343
* **Q: Where can I find Gateway API releases?<br>**
44-
A: Gateway API releases are tags of the [Github repository][1].
45-
The [Github releases][2] page shows all the releases.
44+
A: Gateway API releases are tags of the [Github repository][1].
45+
The [Github releases][2] page shows all the releases.
4646

4747
* **Q: How should I think about alpha API versions?<br>**
48-
A: Similar to upstream Kubernetes, alpha API versions indicate that resources
49-
are still experimental in nature and may either be removed or changed in
50-
breaking ways in future releases of Gateway API.
48+
A: Similar to upstream Kubernetes, alpha API versions indicate that resources
49+
are still experimental in nature and may either be removed or changed in
50+
breaking ways in future releases of Gateway API.
5151

52-
See the [Versioning](https://gateway-api.sigs.k8s.io/concepts/versioning/) documentation for more info.
52+
See the [Versioning](https://gateway-api.sigs.k8s.io/concepts/versioning/) documentation for more info.
5353

5454
* **Q: Which Kubernetes versions are supported?<br>**
55-
A: See our policy on [Supported Version](https://gateway-api.sigs.k8s.io/concepts/versioning/#supported-versions)
56-
57-
* **Q: Is SSL Passthrough supported?**
58-
A: SSL Passthrough (wherein a Gateway routes traffic with the [Transport
59-
Layer Security (TLS)][tls] encryption _intact_ to a backend service instead of
60-
terminating it) is supported by [TLSRoutes][tlsroute]. See the
61-
[TLS Guide][tlsguide] for more details about passthrough and other TLS
62-
configurations.
55+
A: See our policy on [Supported Version](https://gateway-api.sigs.k8s.io/concepts/versioning/#supported-versions)
56+
57+
* **Q: Is SSL Passthrough supported?<br>**
58+
A: SSL Passthrough (wherein a Gateway routes traffic with the [Transport
59+
Layer Security (TLS)][tls] encryption _intact_ to a backend service instead of
60+
terminating it) is supported by [TLSRoutes][tlsroute]. See the
61+
[TLS Guide][tlsguide] for more details about passthrough and other TLS
62+
configurations.
63+
64+
* **Q: What's the difference between Gateway API and an API Gateway?<br>**
65+
A: An API Gateway is a general concept that describes anything that exposes
66+
capabilities of a backend service, while providing extra capabilities for
67+
traffic routing and manipulation, such as load balancing, request and response
68+
transformation, and sometimes more advanced features like authentication and
69+
authorization, rate limiting, and circuit breaking.
70+
71+
Gateway API is an interface, or set of resources, that model service networking
72+
in Kubernetes. One of the main resources is a `Gateway`, which declares the
73+
Gateway type (or class) to instantiate and its configuration. As a Gateway
74+
Provider, you can implement the Gateway API to model Kubernetes service
75+
networking in an expressive, extensible, and role-oriented way.
76+
77+
Most Gateway API implementations are API Gateways to some extent, but not all
78+
API Gateways are Gateway API implementations.
79+
80+
* **Q: Is Gateway API a standard for API Management?<br>**
81+
A: No. API Management is a much broader concept than what Gateway API aims to
82+
be, or what an API Gateway is intended to provide. An API Gateway can be an
83+
essential part of an API Management solution. Gateway API can be seen as a
84+
way to standardize on that aspect of API Management.
6385

6486
[1]: https://github.com/kubernetes-sigs/gateway-api
6587
[2]: https://github.com/kubernetes-sigs/gateway-api/releases

site-src/index.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## What is the Gateway API?
22

33
Gateway API is an open source project managed by the [SIG-NETWORK][sig-network]
4-
community. It is a collection of resources that model service networking
4+
community. It is an API (collection of resources) that model service networking
55
in Kubernetes. These resources - `GatewayClass`, `Gateway`, `HTTPRoute`,
66
`TCPRoute`, `Service`, etc - aim to evolve Kubernetes service networking through
77
expressive, extensible, and role-oriented interfaces that are implemented by
@@ -94,8 +94,24 @@ This flexibility allows the API to adapt to vastly different
9494
organizational models and implementations while remaining a portable and
9595
standard API.
9696

97+
## What's the difference between Gateway API and an API Gateway?
9798

98-
## Who is working on Gateway?
99+
An API Gateway is a general concept that describes anything that exposes
100+
capabilities of a backend service, while providing extra capabilities for
101+
traffic routing and manipulation, such as load balancing, request and response
102+
transformation, and sometimes more advanced features like authentication and
103+
authorization, rate limiting, and circuit breaking.
104+
105+
Gateway API is an interface, or set of resources, that model service networking
106+
in Kubernetes. One of the main resources is a `Gateway`, which declares the
107+
Gateway type (or class) to instantiate and its configuration. As a Gateway
108+
Provider, you can implement the Gateway API to model Kubernetes service
109+
networking in an expressive, extensible, and role-oriented way.
110+
111+
Most Gateway API implementations are API Gateways to some extent, but not all
112+
API Gateways are Gateway API implementations.
113+
114+
## Who is working on Gateway API?
99115

100116
The Gateway API is a
101117
[SIG-Network](https://github.com/kubernetes/community/tree/master/sig-network)

0 commit comments

Comments
 (0)