docs/comments: to distinguish between upstream HTTP filters and upstream network filters (#30744)

Signed-off-by: wbpcode <wbphub@live.com>

Mirrored from https://github.com/envoyproxy/envoy @ 940a54b612595ee1cd4cc4e625ac914d8eb1f97e
main
update-envoy[bot] 2 years ago
parent d5c11b2da7
commit 611fd4f774
  1. 6
      envoy/config/cluster/v3/filter.proto
  2. 12
      envoy/extensions/filters/http/router/v3/router.proto
  3. 10
      envoy/extensions/upstreams/http/v3/http_protocol_options.proto

@ -16,8 +16,8 @@ option java_multiple_files = true;
option go_package = "github.com/envoyproxy/go-control-plane/envoy/config/cluster/v3;clusterv3";
option (udpa.annotations.file_status).package_version_status = ACTIVE;
// [#protodoc-title: Upstream filters]
// Upstream filters apply to the connections to the upstream cluster hosts.
// [#protodoc-title: Upstream network filters]
// Upstream network filters apply to the connections to the upstream cluster hosts.
message Filter {
option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.cluster.Filter";
@ -28,7 +28,7 @@ message Filter {
// Filter specific configuration which depends on the filter being
// instantiated. See the supported filters for further documentation.
// Note that Envoy's :ref:`downstream network
// filters <config_network_filters>` are not valid upstream filters.
// filters <config_network_filters>` are not valid upstream network filters.
// Only one of typed_config or config_discovery can be used.
google.protobuf.Any typed_config = 2;

@ -122,16 +122,16 @@ message Router {
// .. note::
// Upstream HTTP filters are currently in alpha.
//
// Optional HTTP filters for the upstream filter chain.
// Optional HTTP filters for the upstream HTTP filter chain.
//
// These filters will be applied for all requests that pass through the router.
// They will also be applied to shadowed requests.
// Upstream filters cannot change route or cluster.
// Upstream filters specified on the cluster will override these filters.
// Upstream HTTP filters cannot change route or cluster.
// Upstream HTTP filters specified on the cluster will override these filters.
//
// If using upstream filters, please be aware that local errors sent by
// upstream filters will not trigger retries, and local errors sent by
// upstream filters will count as a final response if hedging is configured.
// 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]
repeated network.http_connection_manager.v3.HttpFilter upstream_http_filters = 8;
}

@ -154,14 +154,14 @@ message HttpProtocolOptions {
// .. note::
// Upstream HTTP filters are currently in alpha.
//
// Optional HTTP filters for the upstream filter chain.
// Optional HTTP filters for the upstream HTTP filter chain.
//
// These filters will be applied for all HTTP streams which flow through this
// cluster. Unlike downstream filters, they will *not* be applied to terminated CONNECT requests.
// cluster. Unlike downstream HTTP filters, they will *not* be applied to terminated CONNECT requests.
//
// If using upstream filters, please be aware that local errors sent by
// upstream filters will not trigger retries, and local errors sent by
// upstream filters will count as a final response if hedging is configured.
// 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]
repeated filters.network.http_connection_manager.v3.HttpFilter http_filters = 6;

Loading…
Cancel
Save