From 9c163eb69dbb1b1e738bed50fedf48e784ba0f8c Mon Sep 17 00:00:00 2001 From: Kuat Yessenov Date: Mon, 11 Sep 2023 18:25:00 +0000 Subject: [PATCH] document better Signed-off-by: Kuat Yessenov --- .../advanced/well_known_filter_state.rst | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/root/configuration/advanced/well_known_filter_state.rst b/docs/root/configuration/advanced/well_known_filter_state.rst index 92ebd2f69a50..98aca0ec75e8 100644 --- a/docs/root/configuration/advanced/well_known_filter_state.rst +++ b/docs/root/configuration/advanced/well_known_filter_state.rst @@ -15,14 +15,27 @@ The following list of filter state objects are consumed by Envoy extensions: * - ``envoy.tcp_proxy.cluster`` - | :ref:`TCP proxy ` dynamic cluster name selection | on a per-connection basis. + | Accepts a cluster name as a constructor. * - ``envoy.network.transport_socket.original_dst_address`` - | :ref:`Original destination cluster ` dynamic address selection. + | Accepts an `IP:PORT` string as a constructor. | Fields: - | - *ip*: IP address value; - | - *port*: port value. + | - ``ip``: IP address value as a string; + | - ``port``: port value as a number. * - ``envoy.upstream.dynamic_host`` - | :ref:`Dynamic forward proxy ` | upstream host override on a per-connection basis. + | Accepts a host string as a constructor. * - ``envoy.upstream.dynamic_port`` - | :ref:`Dynamic forward proxy ` | upstream port override on a per-connection basis. + | Accepts a port number string as a constructor. + + +The filter state object fields can be used in the format strings. For example, +the following format string references the port number in the original +destination cluster filter state object: + +.. code-block:: none + + %FILTER_STATE(envoy.network.transport_socket.original_dst_address:FIELD:port)%