Proto changes for pattern template extensions (#22326)
This PR is the first of a series to implement pattern matching and rewrite functionality for Envoy. These specific proto changes: Add the foundation for two extension configs Change the API to expose the extension configs to end users Risk Level: Low Signed-off-by: silverstar195 <seanmaloney@google.com> Mirrored from https://github.com/envoyproxy/envoy @ 25654b97cdd2647c258ae459e6607f51e99c99ccpull/626/head
data-plane-api(Azure Pipelines)
2 years ago
parent
717d4c79fa
commit
0054bdbe18
7 changed files with 135 additions and 74 deletions
@ -0,0 +1,9 @@ |
||||
# DO NOT EDIT. This file is generated by tools/proto_format/proto_sync.py. |
||||
|
||||
load("@envoy_api//bazel:api_build_system.bzl", "api_proto_package") |
||||
|
||||
licenses(["notice"]) # Apache 2 |
||||
|
||||
api_proto_package( |
||||
deps = ["@com_github_cncf_udpa//udpa/annotations:pkg"], |
||||
) |
||||
@ -0,0 +1,44 @@ |
||||
syntax = "proto3"; |
||||
|
||||
package envoy.extensions.path.match.pattern_template.v3; |
||||
|
||||
import "udpa/annotations/status.proto"; |
||||
import "validate/validate.proto"; |
||||
|
||||
option java_package = "io.envoyproxy.envoy.extensions.path.match.pattern_template.v3"; |
||||
option java_outer_classname = "PatternTemplateMatchProto"; |
||||
option java_multiple_files = true; |
||||
option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/path/match/pattern_template/v3;pattern_templatev3"; |
||||
option (udpa.annotations.file_status).package_version_status = ACTIVE; |
||||
|
||||
// [#protodoc-title: Pattern Template Match Config] |
||||
|
||||
// If specified, the route is a template match rule meaning that the |
||||
// ``:path`` header (without the query string) must match the given |
||||
// ``path_template`` pattern. |
||||
// |
||||
// Path template matching types: |
||||
// |
||||
// * ``*`` : Matches a single path component, up to the next path separator: / |
||||
// |
||||
// * ``**`` : Matches zero or more path segments. If present, must be the last operator. |
||||
// |
||||
// * ``{name} or {name=*}`` : A named variable matching one path segment up to the next path separator: /. |
||||
// |
||||
// * ``{name=videos/*}`` : A named variable matching more than one path segment. |
||||
// The path component matching videos/* is captured as the named variable. |
||||
// |
||||
// * ``{name=**}`` : A named variable matching zero or more path segments. |
||||
// |
||||
// |
||||
// For example: |
||||
// |
||||
// * ``/videos/*/*/*.m4s`` would match ``videos/123414/hls/1080p5000_00001.m4s`` |
||||
// |
||||
// * ``/videos/{file}`` would match ``/videos/1080p5000_00001.m4s`` |
||||
// |
||||
// * ``/**.mpd`` would match ``/content/123/india/dash/55/manifest.mpd`` |
||||
// [#not-implemented-hide:] |
||||
message PatternTemplateMatchConfig { |
||||
string path_template = 1 [(validate.rules).string = {min_len: 1 max_len: 256}]; |
||||
} |
||||
@ -0,0 +1,9 @@ |
||||
# DO NOT EDIT. This file is generated by tools/proto_format/proto_sync.py. |
||||
|
||||
load("@envoy_api//bazel:api_build_system.bzl", "api_proto_package") |
||||
|
||||
licenses(["notice"]) # Apache 2 |
||||
|
||||
api_proto_package( |
||||
deps = ["@com_github_cncf_udpa//udpa/annotations:pkg"], |
||||
) |
||||
@ -0,0 +1,58 @@ |
||||
syntax = "proto3"; |
||||
|
||||
package envoy.extensions.path.rewrite.pattern_template.v3; |
||||
|
||||
import "udpa/annotations/status.proto"; |
||||
import "validate/validate.proto"; |
||||
|
||||
option java_package = "io.envoyproxy.envoy.extensions.path.rewrite.pattern_template.v3"; |
||||
option java_outer_classname = "PatternTemplateRewriteProto"; |
||||
option java_multiple_files = true; |
||||
option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/path/rewrite/pattern_template/v3;pattern_templatev3"; |
||||
option (udpa.annotations.file_status).package_version_status = ACTIVE; |
||||
|
||||
// [#protodoc-title: Pattern Template Rewrite Config] |
||||
|
||||
// Indicates that during forwarding, portions of the path that match the |
||||
// pattern should be rewritten, even allowing the substitution of variables |
||||
// from the match pattern into the new path as specified by the rewrite template. |
||||
// This is useful to allow application paths to be |
||||
// rewritten in a way that is aware of segments with variable content like |
||||
// identifiers. The router filter will place the original path as it was |
||||
// before the rewrite into the :ref:`x-envoy-original-path |
||||
// <config_http_filters_router_x-envoy-original-path>` header. |
||||
// |
||||
// Only one of :ref:`prefix_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>`, |
||||
// :ref:`regex_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite>`, |
||||
// or *path_template_rewrite* may be specified. |
||||
// |
||||
// Template pattern matching types: |
||||
// |
||||
// * ``*`` : Matches a single path component, up to the next path separator: / |
||||
// |
||||
// * ``**`` : Matches zero or more path segments. If present, must be the last operator. |
||||
// |
||||
// * ``{name} or {name=*}`` : A named variable matching one path segment up to the next path separator: /. |
||||
// |
||||
// * ``{name=videos/*}`` : A named variable matching more than one path segment. |
||||
// The path component matching videos/* is captured as the named variable. |
||||
// |
||||
// * ``{name=**}`` : A named variable matching zero or more path segments. |
||||
// |
||||
// Only named matches can be used to perform rewrites. |
||||
// |
||||
// Examples using path_template_rewrite: |
||||
// |
||||
// * The pattern ``/{one}/{two}`` paired with a substitution string of ``/{two}/{one}`` would |
||||
// transform ``/cat/dog`` into ``/dog/cat``. |
||||
// |
||||
// * The pattern ``/videos/{language=lang/*}/*`` paired with a substitution string of |
||||
// ``/{language}`` would transform ``/videos/lang/en/video.m4s`` into ``lang/en``. |
||||
// |
||||
// * The path pattern ``/content/{format}/{lang}/{id}/{file}.vtt`` paired with a substitution |
||||
// string of ``/{lang}/{format}/{file}.vtt`` would transform ``/content/hls/en-us/12345/en_193913.vtt`` |
||||
// into ``/en-us/hls/en_193913.vtt``. |
||||
// [#not-implemented-hide:] |
||||
message PatternTemplateRewriteConfig { |
||||
string path_template_rewrite = 1 [(validate.rules).string = {min_len: 1 max_len: 256}]; |
||||
} |
||||
Loading…
Reference in new issue