docs: reorganize configuration tree (#8027)

This is similar to what I did for the arch overview a while ago as this section is also getting out of control. Signed-off-by: Matt Klein <mklein@lyft.com>
envoyproxy · Aug 23, 2019 · 25e3e86 · 25e3e86
1 parent eff0201
commit 25e3e86
Show file tree

Hide file tree

Showing 87 changed files with 96 additions and 40 deletions.
diff --git a/docs/root/configuration/advanced/advanced.rst b/docs/root/configuration/advanced/advanced.rst
@@ -0,0 +1,7 @@
+Advanced
+========
+
+.. toctree::
+  :maxdepth: 2
+
+  well_known_dynamic_metadata
diff --git a/...iguration/well_known_dynamic_metadata.rst → .../advanced/well_known_dynamic_metadata.rst b/...iguration/well_known_dynamic_metadata.rst → .../advanced/well_known_dynamic_metadata.rst
diff --git a/docs/root/configuration/configuration.rst b/docs/root/configuration/configuration.rst
@@ -8,21 +8,12 @@ Configuration reference
 
   overview/v2_overview
   listeners/listeners
-  listener_filters/listener_filters
-  network_filters/network_filters
-  http_conn_man/http_conn_man
-  http_filters/http_filters
-  thrift_filters/thrift_filters
-  dubbo_filters/dubbo_filters
-  cluster_manager/cluster_manager
-  health_checkers/health_checkers
-  access_log
-  rate_limit
-  runtime
-  statistics
-  xds_subscription_stats
-  tools/router_check
-  overload_manager/overload_manager
-  secret
-  well_known_dynamic_metadata
+  http/http
+  upstream/upstream
+  observability/observability
+  security/security
+  operations/operations
+  other_features/other_features
+  other_protocols/other_protocols
+  advanced/advanced
   best_practices/best_practices
diff --git a/docs/root/configuration/http/http.rst b/docs/root/configuration/http/http.rst
@@ -0,0 +1,8 @@
+HTTP
+====
+
+.. toctree::
+  :maxdepth: 2
+
+  http_conn_man/http_conn_man
+  http_filters/http_filters
diff --git a/...ation/http_conn_man/header_sanitizing.rst → .../http/http_conn_man/header_sanitizing.rst b/...ation/http_conn_man/header_sanitizing.rst → .../http/http_conn_man/header_sanitizing.rst
diff --git a/...t/configuration/http_conn_man/headers.rst → ...figuration/http/http_conn_man/headers.rst b/...t/configuration/http_conn_man/headers.rst → ...figuration/http/http_conn_man/headers.rst
diff --git a/...iguration/http_conn_man/http_conn_man.rst → ...tion/http/http_conn_man/http_conn_man.rst b/...iguration/http_conn_man/http_conn_man.rst → ...tion/http/http_conn_man/http_conn_man.rst
diff --git a/.../configuration/http_conn_man/overview.rst → ...iguration/http/http_conn_man/overview.rst b/.../configuration/http_conn_man/overview.rst → ...iguration/http/http_conn_man/overview.rst
diff --git a/.../root/configuration/http_conn_man/rds.rst → .../configuration/http/http_conn_man/rds.rst b/.../root/configuration/http_conn_man/rds.rst → .../configuration/http/http_conn_man/rds.rst
diff --git a/...guration/http_conn_man/route_matching.rst → ...ion/http/http_conn_man/route_matching.rst b/...guration/http_conn_man/route_matching.rst → ...ion/http/http_conn_man/route_matching.rst
diff --git a/...t/configuration/http_conn_man/runtime.rst → ...figuration/http/http_conn_man/runtime.rst b/...t/configuration/http_conn_man/runtime.rst → ...figuration/http/http_conn_man/runtime.rst
diff --git a/...oot/configuration/http_conn_man/stats.rst → ...onfiguration/http/http_conn_man/stats.rst b/...oot/configuration/http_conn_man/stats.rst → ...onfiguration/http/http_conn_man/stats.rst
diff --git a/...ation/http_conn_man/traffic_splitting.rst → .../http/http_conn_man/traffic_splitting.rst b/...ation/http_conn_man/traffic_splitting.rst → .../http/http_conn_man/traffic_splitting.rst
diff --git a/...figuration/http_filters/buffer_filter.rst → ...ation/http/http_filters/buffer_filter.rst b/...figuration/http_filters/buffer_filter.rst → ...ation/http/http_filters/buffer_filter.rst
diff --git a/...onfiguration/http_filters/cors_filter.rst → ...uration/http/http_filters/cors_filter.rst b/...onfiguration/http_filters/cors_filter.rst → ...uration/http/http_filters/cors_filter.rst
diff --git a/...onfiguration/http_filters/csrf_filter.rst → ...uration/http/http_filters/csrf_filter.rst b/...onfiguration/http_filters/csrf_filter.rst → ...uration/http/http_filters/csrf_filter.rst
diff --git a/..._filters/dynamic_forward_proxy_filter.rst → ..._filters/dynamic_forward_proxy_filter.rst b/..._filters/dynamic_forward_proxy_filter.rst → ..._filters/dynamic_forward_proxy_filter.rst
diff --git a/...guration/http_filters/dynamodb_filter.rst → ...ion/http/http_filters/dynamodb_filter.rst b/...guration/http_filters/dynamodb_filter.rst → ...ion/http/http_filters/dynamodb_filter.rst
diff --git a/...uration/http_filters/ext_authz_filter.rst → ...on/http/http_filters/ext_authz_filter.rst b/...uration/http_filters/ext_authz_filter.rst → ...on/http/http_filters/ext_authz_filter.rst
diff --git a/...nfiguration/http_filters/fault_filter.rst → ...ration/http/http_filters/fault_filter.rst b/...nfiguration/http_filters/fault_filter.rst → ...ration/http/http_filters/fault_filter.rst
diff --git a/...http_filters/grpc_http1_bridge_filter.rst → ...http_filters/grpc_http1_bridge_filter.rst b/...http_filters/grpc_http1_bridge_filter.rst → ...http_filters/grpc_http1_bridge_filter.rst
diff --git a/...ters/grpc_http1_reverse_bridge_filter.rst → ...ters/grpc_http1_reverse_bridge_filter.rst b/...ters/grpc_http1_reverse_bridge_filter.rst → ...ters/grpc_http1_reverse_bridge_filter.rst
diff --git a/...p_filters/grpc_json_transcoder_filter.rst → ...p_filters/grpc_json_transcoder_filter.rst b/...p_filters/grpc_json_transcoder_filter.rst → ...p_filters/grpc_json_transcoder_filter.rst
diff --git a/...guration/http_filters/grpc_web_filter.rst → ...ion/http/http_filters/grpc_web_filter.rst b/...guration/http_filters/grpc_web_filter.rst → ...ion/http/http_filters/grpc_web_filter.rst
diff --git a/...onfiguration/http_filters/gzip_filter.rst → ...uration/http/http_filters/gzip_filter.rst b/...onfiguration/http_filters/gzip_filter.rst → ...uration/http/http_filters/gzip_filter.rst
diff --git a/...ttp_filters/header_to_metadata_filter.rst → ...ttp_filters/header_to_metadata_filter.rst b/...ttp_filters/header_to_metadata_filter.rst → ...ttp_filters/header_to_metadata_filter.rst
diff --git a/...tion/http_filters/health_check_filter.rst → ...http/http_filters/health_check_filter.rst b/...tion/http_filters/health_check_filter.rst → ...http/http_filters/health_check_filter.rst
diff --git a/...nfiguration/http_filters/http_filters.rst → ...ration/http/http_filters/http_filters.rst b/...nfiguration/http_filters/http_filters.rst → ...ration/http/http_filters/http_filters.rst
diff --git a/...ration/http_filters/ip_tagging_filter.rst → ...n/http/http_filters/ip_tagging_filter.rst b/...ration/http_filters/ip_tagging_filter.rst → ...n/http/http_filters/ip_tagging_filter.rst
diff --git a/...uration/http_filters/jwt_authn_filter.rst → ...on/http/http_filters/jwt_authn_filter.rst b/...uration/http_filters/jwt_authn_filter.rst → ...on/http/http_filters/jwt_authn_filter.rst
diff --git a/...configuration/http_filters/lua_filter.rst → ...guration/http/http_filters/lua_filter.rst b/...configuration/http_filters/lua_filter.rst → ...guration/http/http_filters/lua_filter.rst
diff --git a/...tion/http_filters/original_src_filter.rst → ...http/http_filters/original_src_filter.rst b/...tion/http_filters/original_src_filter.rst → ...http/http_filters/original_src_filter.rst
diff --git a/...ration/http_filters/rate_limit_filter.rst → ...n/http/http_filters/rate_limit_filter.rst b/...ration/http_filters/rate_limit_filter.rst → ...n/http/http_filters/rate_limit_filter.rst
diff --git a/...onfiguration/http_filters/rbac_filter.rst → ...uration/http/http_filters/rbac_filter.rst b/...onfiguration/http_filters/rbac_filter.rst → ...uration/http/http_filters/rbac_filter.rst
diff --git a/...figuration/http_filters/router_filter.rst → ...ation/http/http_filters/router_filter.rst b/...figuration/http_filters/router_filter.rst → ...ation/http/http_filters/router_filter.rst
diff --git a/...figuration/http_filters/squash_filter.rst → ...ation/http/http_filters/squash_filter.rst b/...figuration/http_filters/squash_filter.rst → ...ation/http/http_filters/squash_filter.rst
diff --git a/...configuration/http_filters/tap_filter.rst → ...guration/http/http_filters/tap_filter.rst b/...configuration/http_filters/tap_filter.rst → ...guration/http/http_filters/tap_filter.rst
diff --git a/...ation/listener_filters/http_inspector.rst → ...eners/listener_filters/http_inspector.rst b/...ation/listener_filters/http_inspector.rst → ...eners/listener_filters/http_inspector.rst
diff --git a/...ion/listener_filters/listener_filters.rst → ...ers/listener_filters/listener_filters.rst b/...ion/listener_filters/listener_filters.rst → ...ers/listener_filters/listener_filters.rst
diff --git a/.../listener_filters/original_dst_filter.rst → .../listener_filters/original_dst_filter.rst b/.../listener_filters/original_dst_filter.rst → .../listener_filters/original_dst_filter.rst
diff --git a/.../listener_filters/original_src_filter.rst → .../listener_filters/original_src_filter.rst b/.../listener_filters/original_src_filter.rst → .../listener_filters/original_src_filter.rst
diff --git a/...ation/listener_filters/proxy_protocol.rst → ...eners/listener_filters/proxy_protocol.rst b/...ation/listener_filters/proxy_protocol.rst → ...eners/listener_filters/proxy_protocol.rst
diff --git a/...ration/listener_filters/tls_inspector.rst → ...teners/listener_filters/tls_inspector.rst b/...ration/listener_filters/tls_inspector.rst → ...teners/listener_filters/tls_inspector.rst
diff --git a/docs/root/configuration/listeners/listeners.rst b/docs/root/configuration/listeners/listeners.rst
@@ -8,4 +8,6 @@ Listeners
 
   overview
   stats
+  listener_filters/listener_filters
+  network_filters/network_filters
   lds
diff --git a/...etwork_filters/client_ssl_auth_filter.rst → ...etwork_filters/client_ssl_auth_filter.rst b/...etwork_filters/client_ssl_auth_filter.rst → ...etwork_filters/client_ssl_auth_filter.rst
diff --git a/...on/network_filters/dubbo_proxy_filter.rst → ...rs/network_filters/dubbo_proxy_filter.rst b/...on/network_filters/dubbo_proxy_filter.rst → ...rs/network_filters/dubbo_proxy_filter.rst
diff --git a/...iguration/network_filters/echo_filter.rst → ...listeners/network_filters/echo_filter.rst b/...iguration/network_filters/echo_filter.rst → ...listeners/network_filters/echo_filter.rst
diff --git a/...tion/network_filters/ext_authz_filter.rst → ...ners/network_filters/ext_authz_filter.rst b/...tion/network_filters/ext_authz_filter.rst → ...ners/network_filters/ext_authz_filter.rst
diff --git a/...on/network_filters/mongo_proxy_filter.rst → ...rs/network_filters/mongo_proxy_filter.rst b/...on/network_filters/mongo_proxy_filter.rst → ...rs/network_filters/mongo_proxy_filter.rst
diff --git a/...on/network_filters/mysql_proxy_filter.rst → ...rs/network_filters/mysql_proxy_filter.rst b/...on/network_filters/mysql_proxy_filter.rst → ...rs/network_filters/mysql_proxy_filter.rst
diff --git a/...ation/network_filters/network_filters.rst → ...eners/network_filters/network_filters.rst b/...ation/network_filters/network_filters.rst → ...eners/network_filters/network_filters.rst
diff --git a/...ion/network_filters/rate_limit_filter.rst → ...ers/network_filters/rate_limit_filter.rst b/...ion/network_filters/rate_limit_filter.rst → ...ers/network_filters/rate_limit_filter.rst
diff --git a/...iguration/network_filters/rbac_filter.rst → ...listeners/network_filters/rbac_filter.rst b/...iguration/network_filters/rbac_filter.rst → ...listeners/network_filters/rbac_filter.rst
diff --git a/...on/network_filters/redis_proxy_filter.rst → ...rs/network_filters/redis_proxy_filter.rst b/...on/network_filters/redis_proxy_filter.rst → ...rs/network_filters/redis_proxy_filter.rst
diff --git a/...on/network_filters/sni_cluster_filter.rst → ...rs/network_filters/sni_cluster_filter.rst b/...on/network_filters/sni_cluster_filter.rst → ...rs/network_filters/sni_cluster_filter.rst
diff --git a/...tion/network_filters/tcp_proxy_filter.rst → ...ners/network_filters/tcp_proxy_filter.rst b/...tion/network_filters/tcp_proxy_filter.rst → ...ners/network_filters/tcp_proxy_filter.rst
diff --git a/...n/network_filters/thrift_proxy_filter.rst → ...s/network_filters/thrift_proxy_filter.rst b/...n/network_filters/thrift_proxy_filter.rst → ...s/network_filters/thrift_proxy_filter.rst
diff --git a/...etwork_filters/zookeeper_proxy_filter.rst → ...etwork_filters/zookeeper_proxy_filter.rst b/...etwork_filters/zookeeper_proxy_filter.rst → ...etwork_filters/zookeeper_proxy_filter.rst
diff --git a/docs/root/configuration/access_log.rst → ...onfiguration/observability/access_log.rst b/docs/root/configuration/access_log.rst → ...onfiguration/observability/access_log.rst
diff --git a/docs/root/configuration/observability/observability.rst b/docs/root/configuration/observability/observability.rst
@@ -0,0 +1,8 @@
+Observability
+=============
+
+.. toctree::
+  :maxdepth: 2
+
+  statistics
+  access_log
diff --git a/docs/root/configuration/statistics.rst → ...onfiguration/observability/statistics.rst b/docs/root/configuration/statistics.rst → ...onfiguration/observability/statistics.rst
diff --git a/docs/root/configuration/operations/operations.rst b/docs/root/configuration/operations/operations.rst
@@ -0,0 +1,9 @@
+Operations
+==========
+
+.. toctree::
+  :maxdepth: 2
+
+  runtime
+  overload_manager/overload_manager
+  tools/router_check
diff --git a/...ion/overload_manager/overload_manager.rst → ...ons/overload_manager/overload_manager.rst b/...ion/overload_manager/overload_manager.rst → ...ons/overload_manager/overload_manager.rst
diff --git a/docs/root/configuration/runtime.rst → ...root/configuration/operations/runtime.rst b/docs/root/configuration/runtime.rst → ...root/configuration/operations/runtime.rst
diff --git a/...root/configuration/tools/router_check.rst → ...uration/operations/tools/router_check.rst b/...root/configuration/tools/router_check.rst → ...uration/operations/tools/router_check.rst
diff --git a/docs/root/configuration/other_features/other_features.rst b/docs/root/configuration/other_features/other_features.rst
@@ -0,0 +1,7 @@
+Other features
+==============
+
+.. toctree::
+  :maxdepth: 2
+
+  rate_limit
diff --git a/docs/root/configuration/rate_limit.rst → ...nfiguration/other_features/rate_limit.rst b/docs/root/configuration/rate_limit.rst → ...nfiguration/other_features/rate_limit.rst
diff --git a/...iguration/dubbo_filters/dubbo_filters.rst → ...protocols/dubbo_filters/dubbo_filters.rst b/...iguration/dubbo_filters/dubbo_filters.rst → ...protocols/dubbo_filters/dubbo_filters.rst
diff --git a/...iguration/dubbo_filters/router_filter.rst → ...protocols/dubbo_filters/router_filter.rst b/...iguration/dubbo_filters/router_filter.rst → ...protocols/dubbo_filters/router_filter.rst
diff --git a/docs/root/configuration/other_protocols/other_protocols.rst b/docs/root/configuration/other_protocols/other_protocols.rst
@@ -0,0 +1,8 @@
+Other protocols
+===============
+
+.. toctree::
+  :maxdepth: 2
+
+  thrift_filters/thrift_filters
+  dubbo_filters/dubbo_filters
diff --git a/...tion/thrift_filters/rate_limit_filter.rst → ...cols/thrift_filters/rate_limit_filter.rst b/...tion/thrift_filters/rate_limit_filter.rst → ...cols/thrift_filters/rate_limit_filter.rst
diff --git a/...guration/thrift_filters/router_filter.rst → ...rotocols/thrift_filters/router_filter.rst b/...guration/thrift_filters/router_filter.rst → ...rotocols/thrift_filters/router_filter.rst
diff --git a/...uration/thrift_filters/thrift_filters.rst → ...otocols/thrift_filters/thrift_filters.rst b/...uration/thrift_filters/thrift_filters.rst → ...otocols/thrift_filters/thrift_filters.rst
diff --git a/docs/root/configuration/overview/v2_overview.rst b/docs/root/configuration/overview/v2_overview.rst
@@ -599,6 +599,30 @@ Management Server has a statistics tree rooted at *control_plane.* with the foll
    rate_limit_enforced, Counter, Total number of times rate limit was enforced for management server requests
    pending_requests, Gauge, Total number of pending requests when the rate limit was enforced
 
+.. _subscription_statistics:
+
+xDS subscription statistics
+---------------------------
+
+Envoy discovers its various dynamic resources via discovery
+services referred to as *xDS*. Resources are requested via :ref:`subscriptions <xds_protocol>`,
+by specifying a filesystem path to watch, initiating gRPC streams or polling a REST-JSON URL.
+
+The following statistics are generated for all subscriptions.
+
+.. csv-table::
+ :header: Name, Type, Description
+ :widths: 1, 1, 2
+
+ config_reload, Counter, Total API fetches that resulted in a config reload due to a different config
+ init_fetch_timeout, Counter, Total :ref:`initial fetch timeouts <envoy_api_field_core.ConfigSource.initial_fetch_timeout>`
+ update_attempt, Counter, Total API fetches attempted
+ update_success, Counter, Total API fetches completed successfully
+ update_failure, Counter, Total API fetches that failed because of network errors
+ update_rejected, Counter, Total API fetches that failed because of schema/validation errors
+ version, Gauge, Hash of the contents from the last successful API fetch
+ control_plane.connected_state, Gauge, A boolean (1 for connected and 0 for disconnected) that indicates the current connection state with management server
+
 .. _config_overview_v2_status:
 
 Status

diff --git a/docs/root/configuration/secret.rst → docs/root/configuration/security/secret.rst b/docs/root/configuration/secret.rst → docs/root/configuration/security/secret.rst
diff --git a/docs/root/configuration/security/security.rst b/docs/root/configuration/security/security.rst
@@ -0,0 +1,7 @@
+Security
+========
+
+.. toctree::
+  :maxdepth: 2
+
+  secret
diff --git a/...oot/configuration/cluster_manager/cds.rst → ...guration/upstream/cluster_manager/cds.rst b/...oot/configuration/cluster_manager/cds.rst → ...guration/upstream/cluster_manager/cds.rst
diff --git a/...ster_manager/cluster_circuit_breakers.rst → ...ster_manager/cluster_circuit_breakers.rst b/...ster_manager/cluster_circuit_breakers.rst → ...ster_manager/cluster_circuit_breakers.rst
diff --git a/...figuration/cluster_manager/cluster_hc.rst → ...n/upstream/cluster_manager/cluster_hc.rst b/...figuration/cluster_manager/cluster_hc.rst → ...n/upstream/cluster_manager/cluster_hc.rst
diff --git a/...ation/cluster_manager/cluster_manager.rst → ...tream/cluster_manager/cluster_manager.rst b/...ation/cluster_manager/cluster_manager.rst → ...tream/cluster_manager/cluster_manager.rst
diff --git a/...ation/cluster_manager/cluster_runtime.rst → ...tream/cluster_manager/cluster_runtime.rst b/...ation/cluster_manager/cluster_runtime.rst → ...tream/cluster_manager/cluster_runtime.rst
diff --git a/...uration/cluster_manager/cluster_stats.rst → ...pstream/cluster_manager/cluster_stats.rst b/...uration/cluster_manager/cluster_stats.rst → ...pstream/cluster_manager/cluster_stats.rst
diff --git a/...onfiguration/cluster_manager/overview.rst → ...ion/upstream/cluster_manager/overview.rst b/...onfiguration/cluster_manager/overview.rst → ...ion/upstream/cluster_manager/overview.rst
diff --git a/...ation/health_checkers/health_checkers.rst → ...tream/health_checkers/health_checkers.rst b/...ation/health_checkers/health_checkers.rst → ...tream/health_checkers/health_checkers.rst
diff --git a/...t/configuration/health_checkers/redis.rst → ...ration/upstream/health_checkers/redis.rst b/...t/configuration/health_checkers/redis.rst → ...ration/upstream/health_checkers/redis.rst
diff --git a/docs/root/configuration/upstream/upstream.rst b/docs/root/configuration/upstream/upstream.rst
@@ -0,0 +1,8 @@
+Upstream clusters
+=================
+
+.. toctree::
+  :maxdepth: 2
+
+  cluster_manager/cluster_manager
+  health_checkers/health_checkers
diff --git a/docs/root/configuration/xds_subscription_stats.rst b/docs/root/configuration/xds_subscription_stats.rst