Skip to content

docs(grpc): add note on using BackendTrafficPolicy for GPRC timeouts #5822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arkodg merged 3 commits into from
May 1, 2025
Merged

docs(grpc): add note on using BackendTrafficPolicy for GPRC timeouts #5822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13ee897
docs(grpc): add note on using for GPRC timeouts
Antvirf Apr 26, 2025
9f11849
Merge branch 'main' into docs/grpc-timeouts
Antvirf Apr 26, 2025
2769d3d
Merge branch 'main' into docs/grpc-timeouts
Antvirf May 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions site/content/en/latest/tasks/traffic/grpc-routing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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/
Expand Down
22 changes: 22 additions & 0 deletions site/content/en/v1.2/tasks/traffic/grpc-routing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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/
Expand Down
22 changes: 22 additions & 0 deletions site/content/en/v1.3/tasks/traffic/grpc-routing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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/
Expand Down