Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that admin mutations should be POST #602

Merged
merged 1 commit into from
Apr 4, 2018
Merged

Document that admin mutations should be POST #602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions docs/root/operations/admin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ modify different aspects of the server:
In the future additional security options will be added to the administration interface. This
work is tracked in `this <https://github.com/envoyproxy/envoy/issues/2763>`_ issue.

All mutations should be sent as HTTP POST operations. For a limited time, they will continue
to work with HTTP GET, with a warning logged.

.. http:get:: /

Render an HTML home page with a table of links to all available options.
Expand Down Expand Up @@ -114,13 +117,13 @@ modify different aspects of the server:
:api:`envoy/admin/v2/config_dump.proto` for more information. That proto is in draft state and is
subject to change.

.. http:get:: /cpuprofiler
.. http:post:: /cpuprofiler

Enable or disable the CPU profiler. Requires compiling with gperftools.

.. _operations_admin_interface_healthcheck_fail:

.. http:get:: /healthcheck/fail
.. http:post:: /healthcheck/fail

Fail inbound health checks. This requires the use of the HTTP :ref:`health check filter
<config_http_filters_health_check>`. This is useful for draining a server prior to shutting it
Expand All @@ -129,9 +132,9 @@ modify different aspects of the server:

.. _operations_admin_interface_healthcheck_ok:

.. http:get:: /healthcheck/ok
.. http:post:: /healthcheck/ok

Negate the effect of :http:get:`/healthcheck/fail`. This requires the use of the HTTP
Negate the effect of :http:post:`/healthcheck/fail`. This requires the use of the HTTP
:ref:`health check filter <config_http_filters_health_check>`.

.. http:get:: /hot_restart_version
Expand All @@ -140,16 +143,16 @@ modify different aspects of the server:

.. _operations_admin_interface_logging:

.. http:get:: /logging
.. http:post:: /logging

Enable/disable different logging levels on different subcomponents. Generally only used during
development.

.. http:get:: /quitquitquit
.. http:post:: /quitquitquit

Cleanly exit the server.

.. http:get:: /reset_counters
.. http:post:: /reset_counters

Reset all counters to zero. This is useful along with :http:get:`/stats` during debugging. Note
that this does not drop any data sent to statsd. It just effects local output of the
Expand Down
2 changes: 1 addition & 1 deletion docs/root/operations/fs_flags.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ flag files are:

drain
If this file exists, Envoy will start in HC failing mode, similar to after the
:http:get:`/healthcheck/fail` command has been executed.
:http:post:`/healthcheck/fail` command has been executed.