docs: remove deprecated fields of regex matching (envoyproxy#21846)

The patch does following up jobs of envoyproxy#21633, 1. removes deprecated fields of regex matching in docs and examples, 2. add the missing deprecation changelog, 3. add the missing extension category and extensions. Risk Level: Low Testing: N/A Docs Changes: Yes (examples) Release Notes: Added Platform Specific Features: N/A Signed-off-by: Xie Zhihao <[email protected]>
AppMonet · Jun 28, 2022 · aa8da55 · aa8da55
1 parent f40d62f
commit aa8da55
Show file tree

Hide file tree

Showing 16 changed files with 453 additions and 139 deletions.
diff --git a/api/envoy/config/bootstrap/v3/bootstrap.proto b/api/envoy/config/bootstrap/v3/bootstrap.proto
@@ -333,6 +333,7 @@ message Bootstrap {
 
   // Optional overriding of default regex engine.
   // If the value is not specified, Google RE2 will be used by default.
+  // [#extension-category: envoy.regex_engines]
   core.v3.TypedExtensionConfig default_regex_engine = 34;
 }
 

diff --git a/api/envoy/extensions/regex_engines/v3/google_re2.proto b/api/envoy/extensions/regex_engines/v3/google_re2.proto
@@ -11,6 +11,7 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/reg
 option (udpa.annotations.file_status).package_version_status = ACTIVE;
 
 // [#protodoc-title: Google RE2]
+// [#extension: envoy.regex_engines.google_re2]
 
 // Google's `RE2 <https://github.com/google/re2>`_ regex engine. The regex string must adhere to
 // the documented `syntax <https://github.com/google/re2/wiki/Syntax>`_. The engine is designed

diff --git a/changelogs/current.yaml b/changelogs/current.yaml
@@ -302,3 +302,6 @@ deprecated:
     deprecated :ref:`old dubbo route config <envoy_v3_api_field_extensions.filters.network.dubbo_proxy.v3.DubboProxy.route_config>`. Please use
     :ref:`multiple route config <envoy_v3_api_field_extensions.filters.network.dubbo_proxy.v3.DubboProxy.multiple_route_config>` or
     :ref:`multiple route config <envoy_v3_api_field_extensions.filters.network.dubbo_proxy.v3.DubboProxy.drds>` first.
+- area: matching
+  change: |
+    :ref:`google_re2 <envoy_v3_api_field_type.matcher.v3.RegexMatcher.google_re2>` has been deprecated.
diff --git a/docs/root/configuration/http/http_filters/_include/header-to-metadata-filter-cookies.yaml b/docs/root/configuration/http/http_filters/_include/header-to-metadata-filter-cookies.yaml
@@ -0,0 +1,57 @@
+static_resources:
+  listeners:
+  - address:
+      socket_address:
+        address: 0.0.0.0
+        port_value: 80
+    filter_chains:
+    - filters:
+      - name: envoy.filters.network.http_connection_manager
+        typed_config:
+          "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
+          codec_type: AUTO
+          stat_prefix: ingress_http
+          route_config:
+            name: local_route
+            virtual_hosts:
+            - name: app
+              domains:
+              - "*"
+              routes:
+              - match:
+                  prefix: "/"
+                route:
+                  cluster: versioned-cluster
+          http_filters:
+          - name: envoy.filters.http.header_to_metadata
+            typed_config:
+              "@type": type.googleapis.com/envoy.extensions.filters.http.header_to_metadata.v3.Config
+              request_rules:
+              - cookie: cookie
+                on_header_present:
+                  metadata_namespace: envoy.lb
+                  key: version
+                  type: STRING
+                on_header_missing:
+                  metadata_namespace: envoy.lb
+                  key: default
+                  value: 'true'
+                  type: STRING
+                remove: false
+          - name: envoy.filters.http.router
+            typed_config:
+              "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
+
+  clusters:
+  - name: versioned-cluster
+    type: STRICT_DNS
+    lb_policy: ROUND_ROBIN
+    load_assignment:
+      cluster_name: versioned-cluster
+      endpoints:
+      - lb_endpoints:
+        - endpoint:
+            address:
+              socket_address:
+                address: 127.0.0.1
+                port_value: 8080
diff --git a/...onfiguration/http/http_filters/_include/header-to-metadata-filter-regex-substitution.yaml b/...onfiguration/http/http_filters/_include/header-to-metadata-filter-regex-substitution.yaml
@@ -0,0 +1,54 @@
+static_resources:
+  listeners:
+  - address:
+      socket_address:
+        address: 0.0.0.0
+        port_value: 80
+    filter_chains:
+    - filters:
+      - name: envoy.filters.network.http_connection_manager
+        typed_config:
+          "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
+          codec_type: AUTO
+          stat_prefix: ingress_http
+          route_config:
+            name: local_route
+            virtual_hosts:
+            - name: app
+              domains:
+              - "*"
+              routes:
+              - match:
+                  prefix: "/"
+                route:
+                  cluster: versioned-cluster
+          http_filters:
+          - name: envoy.filters.http.header_to_metadata
+            typed_config:
+              "@type": type.googleapis.com/envoy.extensions.filters.http.header_to_metadata.v3.Config
+              request_rules:
+              - header: ":path"
+                on_header_present:
+                  metadata_namespace: envoy.lb
+                  key: cluster
+                  regex_value_rewrite:
+                    pattern:
+                      regex: "^/(cluster[\\d\\w-]+)/?.*$"
+                    substitution: "\\1"
+          - name: envoy.filters.http.router
+            typed_config:
+              "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
+
+  clusters:
+  - name: versioned-cluster
+    type: STRICT_DNS
+    lb_policy: ROUND_ROBIN
+    load_assignment:
+      cluster_name: versioned-cluster
+      endpoints:
+      - lb_endpoints:
+        - endpoint:
+            address:
+              socket_address:
+                address: 127.0.0.1
+                port_value: 8080
diff --git a/...root/configuration/http/http_filters/_include/header-to-metadata-filter-route-config.yaml b/...root/configuration/http/http_filters/_include/header-to-metadata-filter-route-config.yaml
@@ -0,0 +1,83 @@
+static_resources:
+  listeners:
+  - address:
+      socket_address:
+        address: 0.0.0.0
+        port_value: 80
+    filter_chains:
+    - filters:
+      - name: envoy.filters.network.http_connection_manager
+        typed_config:
+          "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
+          codec_type: AUTO
+          stat_prefix: ingress_http
+          route_config:
+            name: local_route
+            virtual_hosts:
+            - name: local_service
+              domains:
+              - "*"
+              routes:
+              - match:
+                  prefix: "/version-to-metadata"
+                route:
+                  cluster: service
+                typed_per_filter_config:
+                  envoy.filters.http.header_to_metadata:
+                    "@type": type.googleapis.com/envoy.extensions.filters.http.header_to_metadata.v3.Config
+                    request_rules:
+                    - header: x-version
+                      on_header_present:
+                        metadata_namespace: envoy.lb
+                        key: version
+                        type: STRING
+                      remove: false
+              - match:
+                  prefix: "/"
+                route:
+                  cluster: some_service
+          http_filters:
+          - name: envoy.filters.http.header_to_metadata
+            typed_config:
+              "@type": type.googleapis.com/envoy.extensions.filters.http.header_to_metadata.v3.Config
+              request_rules:
+              - header: x-version
+                on_header_present:
+                  metadata_namespace: envoy.lb
+                  key: version
+                  type: STRING
+                on_header_missing:
+                  metadata_namespace: envoy.lb
+                  key: default
+                  value: "true"
+                  type: STRING
+                remove: false
+          - name: envoy.filters.http.router
+            typed_config:
+              "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
+
+  clusters:
+  - name: service
+    type: STRICT_DNS
+    lb_policy: ROUND_ROBIN
+    load_assignment:
+      cluster_name: service
+      endpoints:
+      - lb_endpoints:
+        - endpoint:
+            address:
+              socket_address:
+                address: 127.0.0.1
+                port_value: 8080
+  - name: some_service
+    type: STRICT_DNS
+    lb_policy: ROUND_ROBIN
+    load_assignment:
+      cluster_name: some_service
+      endpoints:
+      - lb_endpoints:
+        - endpoint:
+            address:
+              socket_address:
+                address: 127.0.0.1
+                port_value: 8081
diff --git a/docs/root/configuration/http/http_filters/_include/header-to-metadata-filter.yaml b/docs/root/configuration/http/http_filters/_include/header-to-metadata-filter.yaml
@@ -0,0 +1,78 @@
+static_resources:
+  listeners:
+  - address:
+      socket_address:
+        address: 0.0.0.0
+        port_value: 80
+    filter_chains:
+    - filters:
+      - name: envoy.filters.network.http_connection_manager
+        typed_config:
+          "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
+          codec_type: AUTO
+          stat_prefix: ingress_http
+          route_config:
+            name: local_route
+            virtual_hosts:
+            - name: app
+              domains:
+              - "*"
+              routes:
+              - match:
+                  prefix: "/"
+                route:
+                  cluster: versioned-cluster
+          http_filters:
+          - name: envoy.filters.http.header_to_metadata
+            typed_config:
+              "@type": type.googleapis.com/envoy.extensions.filters.http.header_to_metadata.v3.Config
+              request_rules:
+              - header: x-version
+                on_header_present:
+                  metadata_namespace: envoy.lb
+                  key: version
+                  type: STRING
+                on_header_missing:
+                  metadata_namespace: envoy.lb
+                  key: default
+                  value: "true"
+                  type: STRING
+                remove: false
+          - name: envoy.filters.http.router
+            typed_config:
+              "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
+
+  clusters:
+  - name: versioned-cluster
+    type: STRICT_DNS
+    lb_policy: ROUND_ROBIN
+    lb_subset_config:
+      fallback_policy: ANY_ENDPOINT
+      subset_selectors:
+        - keys:
+            - default
+        - keys:
+            - version
+    load_assignment:
+      cluster_name: versioned-cluster
+      endpoints:
+      - lb_endpoints:
+        - endpoint:
+            address:
+              socket_address:
+                address: 127.0.0.1
+                port_value: 8080
+          metadata:
+            filter_metadata:
+              envoy.lb:
+                default: "true"
+      - lb_endpoints:
+        - endpoint:
+            address:
+              socket_address:
+                address: 127.0.0.1
+                port_value: 8081
+          metadata:
+            filter_metadata:
+              envoy.lb:
+                version: "1.0"