docs: release note and docs for /config_dump admin endpoint (#559)

Signed-off-by: James Sedgwick <jsedgwick@lyft.com>
pull/583/head
James Sedgwick 7 years ago committed by Matt Klein
parent 09f35b98b6
commit cecc32281d
  1. 5
      docs/conf.py
  2. 5
      docs/root/intro/version_history.rst
  3. 17
      docs/root/operations/admin.rst

@ -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']

@ -3,10 +3,13 @@ Version history
1.7.0
=====
* Added :ref:`weighted round robin
<arch_overview_load_balancing_types_round_robin>` support. The round robin
scheduler now respects endpoint weights and also has improved fidelity across
picks.
* admin: added :ref:`/config_dump endpoint <operations_admin_interface_config_dump>` for dumping current configs
* admin: removed `/routes` endpoint; route configs can now be found at the :ref:`/config_dump endpoint <operations_admin_interface_config_dump>`.
* 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 <operations_admin_interface_logging>` can be configured
@ -208,7 +211,7 @@ Version history
* macOS is :repo:`now supported </bazel#quick-start-bazel-build-for-developers>`. (A few features
are missing such as hot restart and original destination routing).
* YAML is now directly supported for :ref:`config files <config_overview_v1>`.
* Added :ref:`/routes <operations_admin_interface_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 </bazel#log-verbosity>` added.

@ -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=<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:

Loading…
Cancel
Save