diff --git a/site/content/en/latest/tasks/traffic/grpc-routing.md b/site/content/en/latest/tasks/traffic/grpc-routing.md index 3a36e9fd7e..6cbd2f16e8 100644 --- a/site/content/en/latest/tasks/traffic/grpc-routing.md +++ b/site/content/en/latest/tasks/traffic/grpc-routing.md @@ -84,6 +84,7 @@ curl --http2-prior-knowledge -s ${GATEWAY_HOST}:80/yages.Echo/Ping -H 'Host: grp ``` ## GRPCRoute Match + The `matches` field can be used to restrict the route to a specific set of requests based on GRPC's service and/or method names. It supports two match types: `Exact` and `RegularExpression`. @@ -262,6 +263,27 @@ Test GRPC routing to the `yages` backend using the [grpcurl][] command. grpcurl -plaintext -authority=grpc-example.com ${GATEWAY_HOST}:80 yages.Echo/Ping ``` +## Configuring or disabling timeouts with `BackendTrafficPolicy` + +Streaming GRPC connections will often have lifespans longer than the default Envoy proxy timeout of 15 seconds. With Envoy Gateway, this timeout value can be configured using a [BackendTrafficPolicy][] resource: + +```yaml +apiVersion: gateway.envoyproxy.io/v1alpha1 +kind: BackendTrafficPolicy +metadata: + name: configure-timeout-policy +spec: + targetRefs: + - group: gateway.networking.k8s.io + kind: GRPCRoute + name: name-of-my-grpc-route + timeout: + http: + # Set to '0s' to disable timeouts + requestTimeout: 0s +``` + +[BackendTrafficPolicy]: ../../api/extension_types#backendtrafficpolicy [GRPCRoute]: https://gateway-api.sigs.k8s.io/api-types/grpcroute/ [Gateway API documentation]: https://gateway-api.sigs.k8s.io/ [GatewayClass]: https://gateway-api.sigs.k8s.io/api-types/gatewayclass/ diff --git a/site/content/en/v1.2/tasks/traffic/grpc-routing.md b/site/content/en/v1.2/tasks/traffic/grpc-routing.md index 3a36e9fd7e..6cbd2f16e8 100644 --- a/site/content/en/v1.2/tasks/traffic/grpc-routing.md +++ b/site/content/en/v1.2/tasks/traffic/grpc-routing.md @@ -84,6 +84,7 @@ curl --http2-prior-knowledge -s ${GATEWAY_HOST}:80/yages.Echo/Ping -H 'Host: grp ``` ## GRPCRoute Match + The `matches` field can be used to restrict the route to a specific set of requests based on GRPC's service and/or method names. It supports two match types: `Exact` and `RegularExpression`. @@ -262,6 +263,27 @@ Test GRPC routing to the `yages` backend using the [grpcurl][] command. grpcurl -plaintext -authority=grpc-example.com ${GATEWAY_HOST}:80 yages.Echo/Ping ``` +## Configuring or disabling timeouts with `BackendTrafficPolicy` + +Streaming GRPC connections will often have lifespans longer than the default Envoy proxy timeout of 15 seconds. With Envoy Gateway, this timeout value can be configured using a [BackendTrafficPolicy][] resource: + +```yaml +apiVersion: gateway.envoyproxy.io/v1alpha1 +kind: BackendTrafficPolicy +metadata: + name: configure-timeout-policy +spec: + targetRefs: + - group: gateway.networking.k8s.io + kind: GRPCRoute + name: name-of-my-grpc-route + timeout: + http: + # Set to '0s' to disable timeouts + requestTimeout: 0s +``` + +[BackendTrafficPolicy]: ../../api/extension_types#backendtrafficpolicy [GRPCRoute]: https://gateway-api.sigs.k8s.io/api-types/grpcroute/ [Gateway API documentation]: https://gateway-api.sigs.k8s.io/ [GatewayClass]: https://gateway-api.sigs.k8s.io/api-types/gatewayclass/ diff --git a/site/content/en/v1.3/tasks/traffic/grpc-routing.md b/site/content/en/v1.3/tasks/traffic/grpc-routing.md index 3a36e9fd7e..6cbd2f16e8 100644 --- a/site/content/en/v1.3/tasks/traffic/grpc-routing.md +++ b/site/content/en/v1.3/tasks/traffic/grpc-routing.md @@ -84,6 +84,7 @@ curl --http2-prior-knowledge -s ${GATEWAY_HOST}:80/yages.Echo/Ping -H 'Host: grp ``` ## GRPCRoute Match + The `matches` field can be used to restrict the route to a specific set of requests based on GRPC's service and/or method names. It supports two match types: `Exact` and `RegularExpression`. @@ -262,6 +263,27 @@ Test GRPC routing to the `yages` backend using the [grpcurl][] command. grpcurl -plaintext -authority=grpc-example.com ${GATEWAY_HOST}:80 yages.Echo/Ping ``` +## Configuring or disabling timeouts with `BackendTrafficPolicy` + +Streaming GRPC connections will often have lifespans longer than the default Envoy proxy timeout of 15 seconds. With Envoy Gateway, this timeout value can be configured using a [BackendTrafficPolicy][] resource: + +```yaml +apiVersion: gateway.envoyproxy.io/v1alpha1 +kind: BackendTrafficPolicy +metadata: + name: configure-timeout-policy +spec: + targetRefs: + - group: gateway.networking.k8s.io + kind: GRPCRoute + name: name-of-my-grpc-route + timeout: + http: + # Set to '0s' to disable timeouts + requestTimeout: 0s +``` + +[BackendTrafficPolicy]: ../../api/extension_types#backendtrafficpolicy [GRPCRoute]: https://gateway-api.sigs.k8s.io/api-types/grpcroute/ [Gateway API documentation]: https://gateway-api.sigs.k8s.io/ [GatewayClass]: https://gateway-api.sigs.k8s.io/api-types/gatewayclass/