package envoy.extensions.upstreams.http.v3
Get desktop application:
View/edit binary Protocol Buffers messages
message
http_protocol_options.proto:63HttpProtocolOptions specifies Http upstream protocol options. This object is used in :ref:`typed_extension_protocol_options<envoy_v3_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`, keyed by the name ``envoy.extensions.upstreams.http.v3.HttpProtocolOptions``. This controls what protocol(s) should be used for upstream and how said protocol(s) are configured. This replaces the prior pattern of explicit protocol configuration directly in the cluster. So a configuration like this, explicitly configuring the use of HTTP/2 upstream: .. code:: clusters: - name: some_service connect_timeout: 5s upstream_http_protocol_options: auto_sni: true common_http_protocol_options: idle_timeout: 1s http2_protocol_options: max_concurrent_streams: 100 .... [further cluster config] Would now look like this: .. code:: clusters: - name: some_service connect_timeout: 5s typed_extension_protocol_options: envoy.extensions.upstreams.http.v3.HttpProtocolOptions: "@type": type.googleapis.com/envoy.extensions.upstreams.http.v3.HttpProtocolOptions upstream_http_protocol_options: auto_sni: true common_http_protocol_options: idle_timeout: 1s explicit_http_config: http2_protocol_options: max_concurrent_streams: 100 .... [further cluster config] [#next-free-field: 8]
optional common_http_protocol_options = 1
This contains options common across HTTP/1 and HTTP/2
optional upstream_http_protocol_options = 2
This contains common protocol options which are only applied upstream.
oneof upstream_protocol_options
This controls the actual protocol to be used upstream.
explicit_http_config = 3
To explicitly configure either HTTP/1 or HTTP/2 (but not both!) use ``explicit_http_config``.
use_downstream_protocol_config = 4
This allows switching on protocol based on what protocol the downstream connection used.
auto_config = 5
This allows switching on protocol based on ALPN
repeated http_filters = 6
Optional HTTP filters for the upstream HTTP filter chain. .. note:: Upstream HTTP filters are currently in alpha. These filters will be applied for all HTTP streams which flow through this cluster. Unlike downstream HTTP filters, they will *not* be applied to terminated CONNECT requests. If using upstream HTTP filters, please be aware that local errors sent by upstream HTTP filters will not trigger retries, and local errors sent by upstream HTTP filters will count as a final response if hedging is configured. [#extension-category: envoy.filters.http.upstream]
optional header_validation_config = 7
Configuration options for Unified Header Validation (UHV). UHV is an extensible mechanism for checking validity of HTTP responses. [#comment:TODO(yanavlasov): Make it a link to the default header validator doc when it becomes visible.] Leaving this field unspecified, selects the default header validator ``envoy.http.header_validators.envoy_default``. [#not-implemented-hide:] [#extension-category: envoy.http.header_validators]
message
http_protocol_options.proto:106If this is used, the cluster can use either HTTP/1 or HTTP/2, and will use whichever protocol is negotiated by ALPN with the upstream. Clusters configured with ``AutoHttpConfig`` will use the highest available protocol; HTTP/2 if supported, otherwise HTTP/1. If the upstream does not support ALPN, ``AutoHttpConfig`` will fail over to HTTP/1. This can only be used with transport sockets which support ALPN. Using a transport socket which does not support ALPN will result in configuration failure. The transport layer may be configured with custom ALPN, but the default ALPN for the cluster (or if custom ALPN fails) will be "h2,http/1.1".
Used in:
optional http_protocol_options = 1
optional http2_protocol_options = 2
optional http3_protocol_options = 3
Unlike HTTP/1 and HTTP/2, HTTP/3 will not be configured unless it is present, and (soon) only if there is an indication of server side support. See :ref:`here <arch_overview_http3_upstream>` for more information on when HTTP/3 will be used, and when Envoy will fail over to TCP. .. warning:: QUIC upstream support is currently not ready for internet use. Please see :ref:`here <arch_overview_http3>` for details.
optional alternate_protocols_cache_options = 4
The presence of alternate protocols cache options causes the use of the alternate protocols cache, which is responsible for parsing and caching HTTP Alt-Svc headers. This enables the use of HTTP/3 for origins that advertise supporting it. .. note:: This is required when HTTP/3 is enabled.
message
http_protocol_options.proto:66If this is used, the cluster will only operate on one of the possible upstream protocols. Note that HTTP/2 or above should generally be used for upstream gRPC clusters.
Used in:
oneof protocol_config
http_protocol_options = 1
http2_protocol_options = 2
http3_protocol_options = 3
.. warning:: QUIC upstream support is currently not ready for internet use. Please see :ref:`here <arch_overview_http3>` for details.
message
http_protocol_options.proto:86If this is used, the cluster can use either of the configured protocols, and will use whichever protocol was used by the downstream connection. If HTTP/3 is configured for downstream and not configured for upstream, HTTP/3 requests will fail over to HTTP/2.
Used in:
optional http_protocol_options = 1
optional http2_protocol_options = 2
optional http3_protocol_options = 3
.. warning:: QUIC upstream support is currently not ready for internet use. Please see :ref:`here <arch_overview_http3>` for details.