Skip to content

Commit 28a1633

Browse files
docs: clean up config discovery docs and make it consistent (#39918)
Mirrored from https://github.com/envoyproxy/envoy @ a1219ad35ce51f37089892cefb69c7efddd575fe
1 parent a5bf16f commit 28a1633

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

envoy/service/extension/v3/config_discovery.proto

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,29 @@ option (udpa.annotations.file_status).package_version_status = ACTIVE;
1818
// [#protodoc-title: Extension config discovery service (ECDS)]
1919

2020
// A service that supports dynamic configuration updates for a specific filter.
21-
// Currently, ECDS is supported for network filters, HTTP filters, UDP session filters and Listener filters.
21+
// Currently, ECDS is supported for network filters, HTTP filters, UDP session filters, and listener filters.
2222
// Please check :ref:`Extension Config Discovery Service (ECDS) API <config_overview_extension_discovery>`.
23+
//
2324
// The overall extension config discovery service works as follows:
2425
//
25-
// 1. A filter (:ref:`Downstream Network <envoy_v3_api_field_config.listener.v3.Filter.config_discovery>`,
26+
// #. A filter (:ref:`Downstream Network <envoy_v3_api_field_config.listener.v3.Filter.config_discovery>`,
2627
// :ref:`Upstream Network <envoy_v3_api_field_config.cluster.v3.Filter.config_discovery>`,
2728
// :ref:`Listener <envoy_v3_api_field_config.listener.v3.ListenerFilter.config_discovery>`,
2829
// :ref:`UDP Session <envoy_v3_api_field_extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.SessionFilter.config_discovery>`,
2930
// or :ref:`HTTP <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.config_discovery>`)
30-
// contains a :ref:`config_discovery <envoy_v3_api_msg_config.core.v3.ExtensionConfigSource>` configuration. This configuration
31+
// contains a (:ref:`ExtensionConfigSource config discovery <envoy_v3_api_msg_config.core.v3.ExtensionConfigSource>`) configuration. This configuration
3132
// includes a :ref:`config_source <envoy_v3_api_field_config.core.v3.ExtensionConfigSource.config_source>`,
3233
// from which the filter configuration will be fetched.
33-
// 2. The client then registers for a resource using the filter name as the resource_name.
34-
// 3. The xDS server sends back the filter's configuration.
35-
// 4. The client stores the configuration that will be used in the next instantiation of the filter chain,
34+
// #. The client then registers for a resource using the filter name as the ``resource_name``.
35+
// #. The xDS server sends back the filter's configuration.
36+
// #. The client stores the configuration that will be used in the next instantiation of the filter chain,
3637
// i.e., for the next requests. Whenever an updated filter configuration arrives, it will be taken into
3738
// account in the following instantiation of the filter chain.
3839
//
39-
// Note: Filters that are configured using ECDS are warmed. For more details see
40-
// :ref:`ExtensionConfigSource <envoy_v3_api_msg_config.core.v3.ExtensionConfigSource>`.
41-
40+
// .. note::
41+
// Filters that are configured using ECDS are warmed. For more details see
42+
// :ref:`ExtensionConfigSource <envoy_v3_api_msg_config.core.v3.ExtensionConfigSource>`.
43+
//
4244
// Return extension configurations.
4345
service ExtensionConfigDiscoveryService {
4446
option (envoy.annotations.resource).type = "envoy.config.core.v3.TypedExtensionConfig";

0 commit comments

Comments
 (0)