gRPC HTTP/1.1 Reverse Bridge

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

config/filter/http/grpc_http1_reverse_bridge/v2alpha1/config.proto

This extension may be referenced by the qualified name envoy.filters.http.grpc_http1_reverse_bridge

Note

This extension is functional but has not had substantial production burn time, use only with this caveat.

This extension has an unknown security posture and should only be used in deployments where both the downstream and upstream are trusted.

Tip

This extension extends and can be used with the following extension category:

• envoy.filters.http

gRPC HTTP/1.1 Reverse Bridge configuration overview.

extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfig

[extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfig proto]

gRPC reverse bridge filter configuration

{
  "content_type": "...",
  "withhold_grpc_frames": "...",
  "response_size_header": "..."
}

content_type

(string, REQUIRED) The content-type to pass to the upstream when the gRPC bridge filter is applied. The filter will also validate that the upstream responds with the same content type.

withhold_grpc_frames

(bool) If true, Envoy will assume that the upstream doesn’t understand gRPC frames and strip the gRPC frame from the request, and add it back in to the response. This will hide the gRPC semantics from the upstream, allowing it to receive and respond with a simple binary encoded protobuf. In order to calculate the Content-Length header value, Envoy will buffer the upstream response unless response_size_header is set, in which case Envoy will use the value of an upstream header to calculate the content length.

response_size_header

(string) When withhold_grpc_frames is true, this option controls how Envoy calculates the Content-Length. When response_size_header is empty, Envoy will buffer the upstream response to calculate its size. When response_size_header is set to a non-empty string, Envoy will stream the response to the downstream and it will use the value of the response header with this name to set the Content-Length header and gRPC frame size. If the header with this name is repeated, only the first value will be used.

Envoy will treat the upstream response as an error if this option is specified and the header is missing or if the value does not match the actual response body size.

extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfigPerRoute

[extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfigPerRoute proto]

gRPC reverse bridge filter configuration per virtualhost/route/weighted-cluster level.

{
  "disabled": "..."
}

disabled

(bool) If true, disables gRPC reverse bridge filter for this particular vhost or route. If disabled is specified in multiple per-filter-configs, the most specific one will be used.