Skip to content

Commit

Permalink
update gateway api support doc (#1022)
Browse files Browse the repository at this point in the history
* add note about not supported `filters` for `HTTPBackendRef`
* rm `extensionRef` support for `GRPCRoute`
* move the link under docs/latest

Signed-off-by: Arko Dasgupta <arko@tetrate.io>
  • Loading branch information
arkodg committed Feb 10, 2023
1 parent d7a2e19 commit 9991359
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
6 changes: 5 additions & 1 deletion docs/latest/design/gatewayapi-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ All of the following HTTPRoute filters are supported by Envoy Gateway.

**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.

**Note:** the `filters` field within [HTTPBackendRef][] is not supported.

## **TCPRoute**

[TCPRoutes][] are used to configure routing of raw TCP traffic. Traffic can be forwarded to the desired BackendRef(s) based on a port.
Expand All @@ -52,10 +54,11 @@ Similar to HTTPRoutes, Envoy Gateway supports the following filters on GRPCRoute
- `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.
- `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.
- `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.
- `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.

**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

**Note:** the `filters` field within [HTTPBackendRef][] is not supported.

## **TLSRoute**

[TLSRoutes][] are used similarly to TCPRoutes to configure routing of TCP traffic; however, unlike TCPRoutes, TLSRoutes can match against TLS-Specific Metadata.
Expand All @@ -79,6 +82,7 @@ one of its BackendRefs. ReferenceGrants are commonly used to permit these types
[HTTPRoutes]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.HTTPRoute
[Kubernetes Services]: https://kubernetes.io/docs/concepts/services-networking/service/
[BackendRef]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.BackendRef
[HTTPBackendRef]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.HTTPBackendRef
[TCPRoutes]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.TCPRoute
[UDPRoutes]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.UDPRoute
[GRPCRoutes]: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1alpha2.GRPCRoute
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/design_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ Learn about the internal details of Envoy Gateway.
design/egctl
design/ratelimit
design/request-authentication

design/gatewayapi-support
1 change: 0 additions & 1 deletion docs/v0.2.0/design_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ Learn about the internal details of Envoy Gateway.
design/gatewayapi-translator
design/watching
design/config-api
design/gatewayapi-support

0 comments on commit 9991359

Please sign in to comment.