From 2c41495c338ef48f7b17aec0ed7cdbb93247d240 Mon Sep 17 00:00:00 2001 From: Joshua Marantz Date: Tue, 3 Apr 2018 18:16:31 -0400 Subject: [PATCH] doc that admin mutations should be posts Signed-off-by: Joshua Marantz --- docs/root/operations/admin.rst | 17 ++++++++++------- docs/root/operations/fs_flags.rst | 2 +- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index b0a2ef3b1..ef4783ef5 100644 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -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 `_ 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. @@ -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 `. This is useful for draining a server prior to shutting it @@ -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 `. .. http:get:: /hot_restart_version @@ -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 diff --git a/docs/root/operations/fs_flags.rst b/docs/root/operations/fs_flags.rst index 18a3588d5..72aaca1f5 100644 --- a/docs/root/operations/fs_flags.rst +++ b/docs/root/operations/fs_flags.rst @@ -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.