Skip to content

admin: document /runtime endpoint#414

Merged
mattklein123 merged 4 commits intoenvoyproxy:masterfrom
rodaine:admin-runtime-endpoint
Jan 16, 2018
Merged

admin: document /runtime endpoint#414
mattklein123 merged 4 commits intoenvoyproxy:masterfrom
rodaine:admin-runtime-endpoint

Conversation

@rodaine
Copy link
Copy Markdown
Member

@rodaine rodaine commented Jan 12, 2018

Documents the /runtime admin endpoint added for read-only access to the current runtime values.

Related: envoyproxy/envoy#2353

Signed-off-by: Chris Roche <croche@lyft.com>

.. http:get:: /runtime

Outputs all runtime values on demand. See :ref:`here <config_runtime_v1>` for more information on
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe make explicit this is human readable text format (to contrast with JSON below).

Copy link
Copy Markdown
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM other than @htuch comments.

Chris Roche added 2 commits January 12, 2018 09:36
Signed-off-by: Chris Roche <croche@lyft.com>
Signed-off-by: Chris Roche <croche@lyft.com>
.. http:get:: /runtime

Outputs all runtime values on demand in a human-readable format. See
:ref:`here <config_runtime_v1>` for more information on how these values are configured
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please link to this page: https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/runtime, otherwise looks great!

htuch
htuch previously approved these changes Jan 16, 2018
Signed-off-by: Chris Roche <croche@lyft.com>
@mattklein123 mattklein123 merged commit 0747d64 into envoyproxy:master Jan 16, 2018
@rodaine rodaine deleted the admin-runtime-endpoint branch January 16, 2018 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants