api: MetaProtocol Proxy #18823

zhaohuabing · 2021-10-29T07:40:11Z

This PR proposes a MetaProtocol proxy that provides a framework for layer-7 protocols. The common capabilities, including routing, tracing, metrics, logging, etc., will be built into the MetaProtocol proxy. This approach has the potential to significantly lower the barrier to writing new Envoy filters: instead of writing fully functional network filters and duplicating similar codes, now we only need to implement the codec interface. Furthermore, MetaProtocol makes it much easier to build a unified control plane and it could be very helpful for the service mesh ecosystem.

This PR is a merged efforts of #18768 and #18209

This PR is the APIs of the MetaProtocol Proxy. The implementation will be pushed later after the community agrees on the design and finalizes the API.

Related issues:
Common framework for layer-7 protocols #18761
generic proxy support: #18209
Generic Access Log: #13085
Generic Routing & Rds: #9656

Commit Message: Add API for MetaProtocol Proxy
Additional Description:
Design doc: https://docs.google.com/document/d/1y_ALyjGp_H1_TRrrRxZxnqENISqeZI6eLn71FAFsZPk/edit?usp=sharing
Istio blog about MetaProtocol: https://istio.io/latest/blog/2021/aeraki/
This design has been proven working in Aeraki : https://github.com/aeraki-framework/meta-protocol-proxy
Risk Level: low
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Fixes commit #PR or SHA]
[Optional Deprecated:]
[Optional API Considerations:]

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

Signed-off-by: wbpcode <comems@msn.com>

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

Signed-off-by: wbpcode <comems@msn.com>

Minor update

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

Signed-off-by: ubuntu <ubuntu@localhost.localdomain>

repokitteh-read-only · 2021-10-29T07:40:14Z

Hi @zhaohuabing, welcome and thank you for your contribution.

We will try to review your Pull Request as quickly as possible.

In the meantime, please take a look at the contribution guidelines if you have not done so already.

🐱

Caused by: #18823 was opened by zhaohuabing.

see: more, trace.

repokitteh-read-only · 2021-10-29T07:40:20Z

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to (api/envoy/|docs/root/api-docs/).
envoyproxy/api-shepherds assignee is @adisuissa
CC @envoyproxy/api-watchers: FYI only for changes made to (api/envoy/|docs/root/api-docs/).

🐱

Caused by: #18823 was opened by zhaohuabing.

see: more, trace.

zhaohuabing · 2021-10-29T07:55:25Z

@mattklein123 @htuch @rojkov @wbpcode Per our discussion, the merged work starts here.

wbpcode · 2021-10-29T08:11:19Z

Thanks, this would be a great start.

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

Signed-off-by: wbpcode <comems@msn.com>

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

htuch · 2021-11-01T02:23:59Z

Thanks @zhaohuabing @wbpcode. As mentioned before, I'm highly supportive of this work and this seems a solid architectural pattern. I've left a first round of comments on your doc; let's make sure we're all aligned on the details there before diving into code review.

wbpcode · 2021-11-01T03:37:26Z

@htuch Thanks very much. 🌷 We will update our documentation as soon as possible.

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

zhaohuabing · 2021-11-09T08:33:52Z

To fix formatting automatically you can run ./tools/code_format/check_format.py fix. Also it's possible to install git hooks doing prechecks locally upon git push. The hooks can be installed with ./support/bootstrap.

Thanks for the tips @rojkov

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

mattklein123

Thanks this is super cool. Overall this LGTM but per some comments it would be nice to have some more fully formed config examples we can look at?

/wait

mattklein123 · 2021-11-09T16:41:45Z

api/envoy/extensions/filters/network/meta_protocol_proxy/matcher/action/v3/action.proto

+    config.route.v3.WeightedCluster weighted_clusters = 2;
+  }
+  //TODO other configuration: RetryPolicy, Mirroring, Fault Injection, etc.
+}


I agree it's not great to have the duplication, but I would be OK starting from scratch and making sure we don't have ambiguity.

mattklein123 · 2021-11-09T16:42:17Z

api/envoy/extensions/filters/network/meta_protocol_proxy/matcher/v3/matcher.proto

+
+// [#protodoc-title: Meta Protocol Proxy Route Matcher Configuration]
+
+// Used to match request service of the downstream request. Only relevant when the application


Would it be possible in this PR to have some config snippets? somewhere? I think that would really help.

mattklein123 · 2021-11-09T16:42:32Z

api/envoy/extensions/filters/network/meta_protocol_proxy/v3/README.md

@@ -0,0 +1 @@
+Protocol buffer definitions for the MetaProtocol proxy.


nit: delete, we don't need this.

mattklein123 · 2021-11-09T16:43:07Z

api/envoy/extensions/filters/network/meta_protocol_proxy/v3/meta_protocol_proxy.proto

+    // The meta protocol proxies route table will be dynamically loaded via the Meta RDS API.
+    MetaRds rds = 3;
+
+    // The route table for the meta protocol proxy is static and is specified in this property.


You could potentially put examples here, or in the proto docs for RouteConfiguration.

An example of the meta protocol route configuration with matcher API has been added to the route.proto.

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

wbpcode · 2021-11-10T05:42:23Z

api/envoy/extensions/filters/network/meta_protocol_proxy/v3/meta_protocol_proxy.proto

    MetaRds rds = 3;

    // The route table for the meta protocol proxy is static and is specified in this property.
    RouteConfiguration route_config = 4;
  }

-  // The codec which encodes and decodes the application protocol.
-  config.core.v3.TypedExtensionConfig codec = 5 [(validate.rules).message = {required: true}];
-
  // A list of individual Layer-7 filters that make up the filter chain for requests made to the
  // meta protocol proxy. Order matters as the filters are processed sequentially as request events
  // happen. If no meta_protocol_filters are specified, a default router filter
  // (`aeraki.meta_protocol.filters.router`) is used.


remove aeraki.meta_protocol.filters.router

wbpcode

some nit comments.

wbpcode · 2021-11-10T05:43:02Z

api/envoy/extensions/filters/network/meta_protocol_proxy/v3/meta_protocol_proxy.proto

-  // The name of the application protocol built on top of meta protocol.
-  string application_protocol = 2 [(validate.rules).string = {min_len: 1}];
+  // The application protocol built on top of the meta protocol proxy.
+  ApplicationProtocol application_protocol = 2 [(validate.rules).string = {min_len: 1}];


[(validate.rules).message = {required: true}];

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

zhaohuabing · 2021-11-24T03:21:33Z

Hi, @mattklein123

Is there anything I can do to move this forward? Or did I miss something?

mattklein123

Thanks this LGTM and given that it's marked WIP I think we can ship and iterate as needed. @htuch @snowp any further comments on this one?

htuch · 2021-11-30T04:04:50Z

SGTM to merge as WiP, defer to @snowp for final look.

snowp

Just a small comment, this looks great to me!

snowp · 2021-11-30T16:30:25Z

api/envoy/extensions/filters/network/meta_protocol_proxy/matcher/v3/matcher.proto

+// Used to match request service of the downstream request. Only relevant when the application
+// protocol is RPC such as Dubbo or Thrift.
+// [#not-implemented-hide:]
+message ServiceMatchInput {


Are service and method just special properties that we think are common enough to have specific types? Or is there something else that makes them special?

I would probably have the comment be a bit more vague here if they are just special properties, like Only applicable if a method provided by the application protocol. gRPC for example is an RPC protocol that doesn't use methods (outside of google.api.annotations)

@snowp your concern is legitimate, not every RPC protocol has these two properties.

Signed-off-by: huabingzhao <huabingzhao@tencent.com>

snowp

LGTM, thanks!

zhaohuabing and others added 10 commits October 28, 2021 10:34

Add metaprotocol proxy api

41a144b

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

move api to core and update pkg name

0067255

Signed-off-by: wbpcode <comems@msn.com>

move api from contrib to core

71ec328

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

add some minor new API

1ad6b24

Signed-off-by: wbpcode <comems@msn.com>

rename authoriy

7b00d7d

Signed-off-by: wbpcode <comems@msn.com>

Merge pull request #1 from aeraki-framework/minor-update

38b6124

Minor update

minor change

205ac0f

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

format code

387ecb2

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

Modify proto according to envoy api style request

5dfdc72

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

Add MetaProtocol proto to build

5a49dd5

Signed-off-by: ubuntu <ubuntu@localhost.localdomain>

repokitteh-read-only bot added the api label Oct 29, 2021

repokitteh-read-only bot assigned adisuissa Oct 29, 2021

This was referenced Oct 29, 2021

new generic proxy extension to contrib #18765

Closed

generic proxy support #18209

Closed

zhaohuabing added 3 commits October 29, 2021 16:25

fix typo

65cd35d

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

fix proto issue

de25039

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

remove whitespace

e3aa02d

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

mattklein123 assigned mattklein123 and htuch Oct 29, 2021

wbpcode and others added 3 commits October 30, 2021 12:08

fix format and proto api version

dfb16ec

Signed-off-by: wbpcode <comems@msn.com>

The MetaProtocol Proxy is still under development

ff3c2b6

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

should be ACTIVE according to definition of UDPA

0e8e9c0

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

htuch mentioned this pull request Nov 1, 2021

thrift: adding xDS RDS support for thrift proxy. #17631

Closed

Use the xds mathcer API for routing

851923d

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

fix check format

88ce891

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

wbpcode mentioned this pull request Nov 9, 2021

add core framework of meta protocol proxy #18944

Closed

use typedExtensionConfig

b72d0ab

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

mattklein123 requested changes Nov 9, 2021

View reviewed changes

repokitteh-read-only bot added the waiting label Nov 9, 2021

add config example

e93277f

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

repokitteh-read-only bot removed the waiting label Nov 10, 2021

wbpcode reviewed Nov 10, 2021

View reviewed changes

wbpcode requested changes Nov 10, 2021

View reviewed changes

zhaohuabing added 2 commits November 10, 2021 14:53

fix validation error

e7c33c9

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

remove aeraki.meta_protocol.filters.router

4d415c3

Signed-off-by: zhaohuabing <zhaohuabing@gmail.com>

zhaohuabing requested a review from mattklein123 November 11, 2021 07:40

mattklein123 previously approved these changes Nov 29, 2021

View reviewed changes

repokitteh-read-only bot removed the api label Nov 29, 2021

mattklein123 assigned snowp and unassigned adisuissa, mattklein123 and htuch Nov 30, 2021

snowp reviewed Nov 30, 2021

View reviewed changes

minor wording

1def61e

Signed-off-by: huabingzhao <huabingzhao@tencent.com>

zhaohuabing dismissed mattklein123’s stale review via 1def61e December 2, 2021 07:59

repokitteh-read-only bot added the api label Dec 2, 2021

zhaohuabing requested review from snowp and htuch December 2, 2021 11:44

snowp approved these changes Dec 3, 2021

View reviewed changes

snowp merged commit de51441 into envoyproxy:main Dec 3, 2021

wangfakang mentioned this pull request Nov 15, 2022

Envoy's L7 Go extension API #22573

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

api: MetaProtocol Proxy #18823

api: MetaProtocol Proxy #18823

zhaohuabing commented Oct 29, 2021 •

edited

Loading

repokitteh-read-only bot commented Oct 29, 2021

repokitteh-read-only bot commented Oct 29, 2021

zhaohuabing commented Oct 29, 2021 •

edited

Loading

wbpcode commented Oct 29, 2021 •

edited

Loading

htuch commented Nov 1, 2021

wbpcode commented Nov 1, 2021

zhaohuabing commented Nov 9, 2021 •

edited

Loading

mattklein123 left a comment

mattklein123 Nov 9, 2021

mattklein123 Nov 9, 2021

mattklein123 Nov 9, 2021

zhaohuabing Nov 10, 2021

mattklein123 Nov 9, 2021

zhaohuabing Nov 10, 2021

wbpcode Nov 10, 2021

zhaohuabing Nov 10, 2021

wbpcode left a comment

wbpcode Nov 10, 2021

zhaohuabing Nov 10, 2021

zhaohuabing commented Nov 24, 2021 •

edited

Loading

mattklein123 left a comment

htuch commented Nov 30, 2021

snowp left a comment

snowp Nov 30, 2021

zhaohuabing Dec 2, 2021

snowp left a comment


		// [#protodoc-title: Meta Protocol Proxy Route Matcher Configuration]

		// Used to match request service of the downstream request. Only relevant when the application

		@@ -0,0 +1 @@
		Protocol buffer definitions for the MetaProtocol proxy.

api: MetaProtocol Proxy #18823

api: MetaProtocol Proxy #18823

Conversation

zhaohuabing commented Oct 29, 2021 • edited Loading

repokitteh-read-only bot commented Oct 29, 2021

repokitteh-read-only bot commented Oct 29, 2021

zhaohuabing commented Oct 29, 2021 • edited Loading

wbpcode commented Oct 29, 2021 • edited Loading

htuch commented Nov 1, 2021

wbpcode commented Nov 1, 2021

zhaohuabing commented Nov 9, 2021 • edited Loading

mattklein123 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wbpcode left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhaohuabing commented Nov 24, 2021 • edited Loading

mattklein123 left a comment

Choose a reason for hiding this comment

htuch commented Nov 30, 2021

snowp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

snowp left a comment

Choose a reason for hiding this comment

zhaohuabing commented Oct 29, 2021 •

edited

Loading

zhaohuabing commented Oct 29, 2021 •

edited

Loading

wbpcode commented Oct 29, 2021 •

edited

Loading

zhaohuabing commented Nov 9, 2021 •

edited

Loading

zhaohuabing commented Nov 24, 2021 •

edited

Loading