mirror of
https://github.com/bytedance/g3.git
synced 2026-05-02 13:40:42 +00:00
update doc about egress path selection
This commit is contained in:
parent
ad3742921e
commit
e9d8f45a02
6 changed files with 75 additions and 8 deletions
|
|
@ -13,6 +13,12 @@ The following interfaces are supported:
|
|||
* http(s) forward
|
||||
* ftp over http
|
||||
|
||||
The following egress path selection methods is supported:
|
||||
|
||||
* :ref:`by index <proto_egress_path_selection_by_index>`
|
||||
|
||||
The index will be used as the index of the binding IP address
|
||||
|
||||
The following common keys are supported:
|
||||
|
||||
* :ref:`shared_logger <conf_escaper_common_shared_logger>`
|
||||
|
|
|
|||
|
|
@ -10,7 +10,17 @@ can be set via the `publish` rpc method.
|
|||
The following interfaces are supported:
|
||||
|
||||
* tcp connect
|
||||
* udp relay
|
||||
* udp connect
|
||||
* http(s) forward
|
||||
* ftp over http
|
||||
|
||||
The following egress path selection methods is supported:
|
||||
|
||||
* :ref:`by json <proto_egress_path_selection_by_json>`
|
||||
|
||||
The json value will be parsed as one (json map) or more (json array) :ref:`Bind IP <config_escaper_dynamic_bind_ip>`.
|
||||
The bind ips passed here will overwrite the ones in the escaper config.
|
||||
|
||||
The Cap'n Proto RPC publish command is supported on this escaper, the published data should be a map, with the keys:
|
||||
|
||||
|
|
|
|||
|
|
@ -6,16 +6,26 @@ proxy_float
|
|||
|
||||
This escaper provide the capability to access the target upstream through dynamic remote proxies.
|
||||
|
||||
The following interfaces are supported:
|
||||
|
||||
* tcp connect
|
||||
* http(s) forward
|
||||
|
||||
The following remote proxy protocols are supported:
|
||||
|
||||
* Http Proxy
|
||||
* Https Proxy
|
||||
* Socks5 Proxy
|
||||
|
||||
The following interfaces are supported:
|
||||
|
||||
* tcp connect
|
||||
* udp relay (only socks5 peer)
|
||||
* udp connect (only socks5 peer)
|
||||
* http(s) forward
|
||||
|
||||
The following egress path selection methods is supported:
|
||||
|
||||
* :ref:`by json <proto_egress_path_selection_by_json>`
|
||||
|
||||
The json value will be parsed as one (json map) or more (json array) :ref:`peer <config_escaper_dynamic_peer>`.
|
||||
The peers passed here will overwrite the ones in the escaper config.
|
||||
|
||||
The Cap'n Proto RPC publish command is supported on this escaper, the published data should be an array of
|
||||
or just one :ref:`peer <config_escaper_dynamic_peer>`.
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,13 @@ route_mapping
|
|||
|
||||
This escaper allows to select a next escaper based on the user specified path selection index.
|
||||
|
||||
If no index can be get from the path selection method, the default random one will be used.
|
||||
The following egress path selection methods is supported:
|
||||
|
||||
* :ref:`by index <proto_egress_path_selection_by_index>`
|
||||
|
||||
The index will be used as the index of the next escaper
|
||||
|
||||
If no index can be get from the path selection method, the default random one will be used.
|
||||
|
||||
No common keys are supported.
|
||||
|
||||
|
|
|
|||
|
|
@ -343,3 +343,14 @@ explicit_sites
|
|||
Set explicit sites for this user.
|
||||
|
||||
.. versionadded:: 1.3.4
|
||||
|
||||
.. _config_user_egress_path:
|
||||
|
||||
egress_path
|
||||
-----------
|
||||
|
||||
**optional**, **type**: :ref:`by json egress path <proto_egress_path_selection_by_json>`
|
||||
|
||||
Set egress path selection for this user.
|
||||
|
||||
.. versionadded:: 1.7.22
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue