From 08cf8d880c5b391776a0ec9c37ede5cad44c4e63 Mon Sep 17 00:00:00 2001 From: "data-plane-api(CircleCI)" Date: Thu, 27 Feb 2020 18:30:05 +0000 Subject: [PATCH] http filters: use new style names (#10103) Modifies the well-known-names of the built-in http filters to use the same names as the extension build system. Handles transition of per-filter-configs. Risk Level: low, previous name is still accepted Testing: existing tests + deprecated tests for old names Docs Changes: updated names Release Notes: updated Deprecated: old names are logged as deprecated Signed-off-by: Stephan Zuercher Mirrored from https://github.com/envoyproxy/envoy @ c5c1e5bb6570f81f30dd48d8b379392c84e81fe0 --- envoy/api/v2/cluster.proto | 2 +- envoy/api/v2/core/base.proto | 2 +- envoy/api/v2/route/route_components.proto | 14 +++++++------- envoy/config/cluster/v3/cluster.proto | 2 +- envoy/config/core/v3/base.proto | 2 +- envoy/config/route/v3/route_components.proto | 8 ++++---- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/envoy/api/v2/cluster.proto b/envoy/api/v2/cluster.proto index 2d61ef3f..f7755d6e 100644 --- a/envoy/api/v2/cluster.proto +++ b/envoy/api/v2/cluster.proto @@ -734,7 +734,7 @@ message Cluster { // cluster. It can be used for stats, logging, and varying filter behavior. // Fields should use reverse DNS notation to denote which entity within Envoy // will need the information. For instance, if the metadata is intended for - // the Router filter, the filter name should be specified as *envoy.router*. + // the Router filter, the filter name should be specified as *envoy.filters.http.router*. core.Metadata metadata = 25; // Determines how Envoy selects the protocol used to speak to upstream hosts. diff --git a/envoy/api/v2/core/base.proto b/envoy/api/v2/core/base.proto index 43403633..6abb6540 100644 --- a/envoy/api/v2/core/base.proto +++ b/envoy/api/v2/core/base.proto @@ -94,7 +94,7 @@ message BuildVersion { // [#next-free-field: 6] message Extension { // This is the name of the Envoy filter as specified in the Envoy - // configuration, e.g. envoy.router, com.acme.widget. + // configuration, e.g. envoy.filters.http.router, com.acme.widget. string name = 1; // Category of the extension. diff --git a/envoy/api/v2/route/route_components.proto b/envoy/api/v2/route/route_components.proto index e3664d68..6a23c88e 100644 --- a/envoy/api/v2/route/route_components.proto +++ b/envoy/api/v2/route/route_components.proto @@ -123,14 +123,14 @@ message VirtualHost { // The per_filter_config field can be used to provide virtual host-specific // configurations for filters. The key should match the filter name, such as - // *envoy.buffer* for the HTTP buffer filter. Use of this field is filter + // *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter // specific; see the :ref:`HTTP filter documentation ` // for if and how it is utilized. map per_filter_config = 12 [deprecated = true]; // The per_filter_config field can be used to provide virtual host-specific // configurations for filters. The key should match the filter name, such as - // *envoy.buffer* for the HTTP buffer filter. Use of this field is filter + // *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter // specific; see the :ref:`HTTP filter documentation ` // for if and how it is utilized. map typed_per_filter_config = 15; @@ -205,7 +205,7 @@ message Route { // about the route. It can be used for configuration, stats, and logging. // The metadata should go under the filter namespace that will need it. // For instance, if the metadata is intended for the Router filter, - // the filter name should be specified as *envoy.router*. + // the filter name should be specified as *envoy.filters.http.router*. core.Metadata metadata = 4; // Decorator for the matched route. @@ -213,14 +213,14 @@ message Route { // The per_filter_config field can be used to provide route-specific // configurations for filters. The key should match the filter name, such as - // *envoy.buffer* for the HTTP buffer filter. Use of this field is filter + // *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter // specific; see the :ref:`HTTP filter documentation ` for // if and how it is utilized. map per_filter_config = 8 [deprecated = true]; // The typed_per_filter_config field can be used to provide route-specific // configurations for filters. The key should match the filter name, such as - // *envoy.buffer* for the HTTP buffer filter. Use of this field is filter + // *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter // specific; see the :ref:`HTTP filter documentation ` for // if and how it is utilized. map typed_per_filter_config = 13; @@ -319,14 +319,14 @@ message WeightedCluster { // The per_filter_config field can be used to provide weighted cluster-specific // configurations for filters. The key should match the filter name, such as - // *envoy.buffer* for the HTTP buffer filter. Use of this field is filter + // *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter // specific; see the :ref:`HTTP filter documentation ` // for if and how it is utilized. map per_filter_config = 8 [deprecated = true]; // The per_filter_config field can be used to provide weighted cluster-specific // configurations for filters. The key should match the filter name, such as - // *envoy.buffer* for the HTTP buffer filter. Use of this field is filter + // *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter // specific; see the :ref:`HTTP filter documentation ` // for if and how it is utilized. map typed_per_filter_config = 10; diff --git a/envoy/config/cluster/v3/cluster.proto b/envoy/config/cluster/v3/cluster.proto index 3a71f8f1..e0726d8e 100644 --- a/envoy/config/cluster/v3/cluster.proto +++ b/envoy/config/cluster/v3/cluster.proto @@ -736,7 +736,7 @@ message Cluster { // cluster. It can be used for stats, logging, and varying filter behavior. // Fields should use reverse DNS notation to denote which entity within Envoy // will need the information. For instance, if the metadata is intended for - // the Router filter, the filter name should be specified as *envoy.router*. + // the Router filter, the filter name should be specified as *envoy.filters.http.router*. core.v3.Metadata metadata = 25; // Determines how Envoy selects the protocol used to speak to upstream hosts. diff --git a/envoy/config/core/v3/base.proto b/envoy/config/core/v3/base.proto index 4def9c0b..0d8cf6e3 100644 --- a/envoy/config/core/v3/base.proto +++ b/envoy/config/core/v3/base.proto @@ -100,7 +100,7 @@ message Extension { option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.Extension"; // This is the name of the Envoy filter as specified in the Envoy - // configuration, e.g. envoy.router, com.acme.widget. + // configuration, e.g. envoy.filters.http.router, com.acme.widget. string name = 1; // Category of the extension. diff --git a/envoy/config/route/v3/route_components.proto b/envoy/config/route/v3/route_components.proto index 06ef6520..668b722a 100644 --- a/envoy/config/route/v3/route_components.proto +++ b/envoy/config/route/v3/route_components.proto @@ -127,7 +127,7 @@ message VirtualHost { // The per_filter_config field can be used to provide virtual host-specific // configurations for filters. The key should match the filter name, such as - // *envoy.buffer* for the HTTP buffer filter. Use of this field is filter + // *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter // specific; see the :ref:`HTTP filter documentation ` // for if and how it is utilized. map typed_per_filter_config = 15; @@ -208,7 +208,7 @@ message Route { // about the route. It can be used for configuration, stats, and logging. // The metadata should go under the filter namespace that will need it. // For instance, if the metadata is intended for the Router filter, - // the filter name should be specified as *envoy.router*. + // the filter name should be specified as *envoy.filters.http.router*. core.v3.Metadata metadata = 4; // Decorator for the matched route. @@ -216,7 +216,7 @@ message Route { // The typed_per_filter_config field can be used to provide route-specific // configurations for filters. The key should match the filter name, such as - // *envoy.buffer* for the HTTP buffer filter. Use of this field is filter + // *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter // specific; see the :ref:`HTTP filter documentation ` for // if and how it is utilized. map typed_per_filter_config = 13; @@ -322,7 +322,7 @@ message WeightedCluster { // The per_filter_config field can be used to provide weighted cluster-specific // configurations for filters. The key should match the filter name, such as - // *envoy.buffer* for the HTTP buffer filter. Use of this field is filter + // *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter // specific; see the :ref:`HTTP filter documentation ` // for if and how it is utilized. map typed_per_filter_config = 10;