docs: /runtime_modify admin endpoint docs#557
docs: /runtime_modify admin endpoint docs#557mattklein123 merged 7 commits intoenvoyproxy:masterfrom jsedgwick:runtime_modify
Conversation
mattklein123
left a comment
mattklein123
left a comment
There was a problem hiding this comment.
LGTM, thanks. Might need to be modified depending on what we decide to do with viewing override values via /runtime. Also needs format fix.
|
Formatted. Left comments about viewing runtime on the envoy PR |
| :ref:`/runtime admin endpoint <operations_admin_interface_runtime>`. Values can be modified and | ||
| added at the :ref:`/runtime_modify admin endpoint <operations_admin_interface_runtime_modify>`. If | ||
| runtime is not configured, an empty provider is used which has the effect of using all defaults | ||
| built into the code, except for any values added via `/runtime_modify`. |
There was a problem hiding this comment.
Maybe this could merit an additional ::attention:: comment on the dangers of the admin endpoint. We're now exposing a lot more knobs via this PR.
There was a problem hiding this comment.
+1, I would just let people know that admin values can get tweaked via the endpoint and that they need to pay special attention to admin security (paraphrasing).
mattklein123
left a comment
mattklein123
left a comment
There was a problem hiding this comment.
LGTM, just a few fixups needed. Thanks!
| v0.0.4 format. This can be used to integrate with a Prometheus server. Currently, only counters and | ||
| gauges are output. Histograms will be output in a future update. | ||
|
|
||
| .. _operations_admin_interface_runtime: |
There was a problem hiding this comment.
Can you add some more expansive docs here on the new JSON output?
|
|
||
| 1.6.0 | ||
| ===== | ||
| * admin: added :ref:`/runtime_modify endpoint <operations_admin_interface_runtime_modify>` to add or change runtime values |
There was a problem hiding this comment.
please move up to 1.7.0 section.
| :ref:`/runtime admin endpoint <operations_admin_interface_runtime>`. Values can be modified and | ||
| added at the :ref:`/runtime_modify admin endpoint <operations_admin_interface_runtime_modify>`. If | ||
| runtime is not configured, an empty provider is used which has the effect of using all defaults | ||
| built into the code, except for any values added via `/runtime_modify`. |
There was a problem hiding this comment.
+1, I would just let people know that admin values can get tweaked via the endpoint and that they need to pay special attention to admin security (paraphrasing).
|
PTAL |
3 participants
Plus a release note