From cecc32281d6523b1bd909354660793389ddfc5d6 Mon Sep 17 00:00:00 2001 From: James Sedgwick Date: Tue, 27 Mar 2018 13:32:29 -0400 Subject: [PATCH] docs: release note and docs for /config_dump admin endpoint (#559) Signed-off-by: James Sedgwick --- docs/conf.py | 5 ++++- docs/root/intro/version_history.rst | 5 ++++- docs/root/operations/admin.rst | 17 +++++++++-------- 3 files changed, 17 insertions(+), 10 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 5f500c7d..b8fe20c0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,7 +38,10 @@ release_level = os.environ['ENVOY_DOCS_RELEASE_LEVEL'] # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.extlinks', 'sphinx.ext.ifconfig'] -extlinks = {'repo': ('https://github.com/envoyproxy/envoy/blob/master/%s', '')} +extlinks = { + 'repo': ('https://github.com/envoyproxy/envoy/blob/master/%s', ''), + 'api': ('https://github.com/envoyproxy/data-plane-api/blob/master/%s', ''), +} # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/root/intro/version_history.rst b/docs/root/intro/version_history.rst index 45263e38..b147a58d 100644 --- a/docs/root/intro/version_history.rst +++ b/docs/root/intro/version_history.rst @@ -3,10 +3,13 @@ Version history 1.7.0 ===== + * Added :ref:`weighted round robin ` support. The round robin scheduler now respects endpoint weights and also has improved fidelity across picks. +* admin: added :ref:`/config_dump endpoint ` for dumping current configs +* admin: removed `/routes` endpoint; route configs can now be found at the :ref:`/config_dump endpoint `. * access log: ability to format START_TIME * admin: added ``/stats/prometheus`` as an alternative endpoint for getting stats in prometheus format. * logger: all :ref:`logging levels ` can be configured @@ -208,7 +211,7 @@ Version history * macOS is :repo:`now supported `. (A few features are missing such as hot restart and original destination routing). * YAML is now directly supported for :ref:`config files `. -* Added :ref:`/routes ` admin endpoint. +* Added /routes admin endpoint. * End-to-end flow control is now supported for TCP proxy, HTTP/1, and HTTP/2. HTTP flow control that includes filter buffering is incomplete and will be implemented in 1.5.0. * Log verbosity :repo:`compile time flag ` added. diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index 87249906..1e75d4ec 100644 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -103,6 +103,15 @@ modify different aspects of the server: */failed_outlier_check*: The host has failed an outlier detection check. +.. _operations_admin_interface_config_dump: + +.. http:get:: /config_dump + + Dump currently loaded configuration from various Envoy components as JSON-serialized proto + messages. Currently, only route configs are available but more are on the way. See + :api:`envoy/admin/v2/config_dump.proto` for more information. That proto is in draft state and is + subject to change. + .. http:get:: /cpuprofiler Enable or disable the CPU profiler. Requires compiling with gperftools. @@ -144,14 +153,6 @@ modify different aspects of the server: that this does not drop any data sent to statsd. It just effects local output of the :http:get:`/stats` command. -.. _operations_admin_interface_routes: - -.. http:get:: /routes?route_config_name= - - This endpoint is only available if envoy has HTTP routes configured via RDS. - The endpoint dumps all the configured HTTP route tables, or only ones that - match the ``route_config_name`` query, if a query is specified. - .. http:get:: /server_info Outputs information about the running server. Sample output looks like: