Skip to content

Commit 9991359

Browse files
authored
update gateway api support doc (#1022)
* add note about not supported `filters` for `HTTPBackendRef` * rm `extensionRef` support for `GRPCRoute` * move the link under docs/latest Signed-off-by: Arko Dasgupta <[email protected]>
1 parent d7a2e19 commit 9991359

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

docs/latest/design/gatewayapi-support.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ All of the following HTTPRoute filters are supported by Envoy Gateway.
3030

3131
**Note:** currently the only [BackendRef][] kind (the destination where traffic should be sent to) that Envoy Gateway supports are [Kubernetes Services][]. Routing traffic to other destinations such as arbitrary URLs is not currently possible.
3232

33+
**Note:** the `filters` field within [HTTPBackendRef][] is not supported.
34+
3335
## **TCPRoute**
3436

3537
[TCPRoutes][] are used to configure routing of raw TCP traffic. Traffic can be forwarded to the desired BackendRef(s) based on a port.
@@ -52,10 +54,11 @@ Similar to HTTPRoutes, Envoy Gateway supports the following filters on GRPCRoute
5254
- `requestHeaderModifier`: [RequestHeaderModifiers](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.GRPCRouteFilter) can be used to modify or add request headers before the request is proxied to its destination.
5355
- `responseHeaderModifier`: [ResponseHeaderModifiers](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.GRPCRouteFilter) can be used to modify or add response headers before the response is sent back to the client.
5456
- `requestMirror`: [RequestMirrors](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.GRPCRouteFilter) configure destinations where the requests should also be mirrored to. Responses to mirrored requests will be ignored.
55-
- `extensionRef`: [ExtensionRefs] are used by Envoy Gateway to add additional support for Ratelimitg and Authentication. For more information about Envoy Gateay's implementation of these filters please refer to the [Ratelimiting][] and [Authentication][] documentation.
5657

5758
**Note:** currently the only [BackendRef](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.GRPCRouteFilter) kind (the destination where traffic should be sent to) that Envoy Gateway supports are [Kubernetes Services][]. Routing traffic to other destinations such as arbitrary URLs is not currently possible
5859

60+
**Note:** the `filters` field within [HTTPBackendRef][] is not supported.
61+
5962
## **TLSRoute**
6063

6164
[TLSRoutes][] are used similarly to TCPRoutes to configure routing of TCP traffic; however, unlike TCPRoutes, TLSRoutes can match against TLS-Specific Metadata.
@@ -79,6 +82,7 @@ one of its BackendRefs. ReferenceGrants are commonly used to permit these types
7982
[HTTPRoutes]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.HTTPRoute
8083
[Kubernetes Services]: https://kubernetes.io/docs/concepts/services-networking/service/
8184
[BackendRef]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.BackendRef
85+
[HTTPBackendRef]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.HTTPBackendRef
8286
[TCPRoutes]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.TCPRoute
8387
[UDPRoutes]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.UDPRoute
8488
[GRPCRoutes]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.GRPCRoute

docs/latest/design_docs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ Learn about the internal details of Envoy Gateway.
1414
design/egctl
1515
design/ratelimit
1616
design/request-authentication
17-
17+
design/gatewayapi-support

docs/v0.2.0/design_docs.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,3 @@ Learn about the internal details of Envoy Gateway.
1010
design/gatewayapi-translator
1111
design/watching
1212
design/config-api
13-
design/gatewayapi-support

0 commit comments

Comments
 (0)