docs: add admin endpoint gating guidance with allow_paths examples#43468
docs: add admin endpoint gating guidance with allow_paths examples#43468garimauttam wants to merge 6 commits intoenvoyproxy:mainfrom
Conversation
|
Docs for this Pull Request will be rendered here: https://storage.googleapis.com/envoy-cncf-pr/43468/docs/index.html The docs are (re-)rendered each time the CI |
garimauttam
had a problem deploying
to
external-contributors
GitHub Actions
Error
|
Hi @garimauttam, welcome and thank you for your contribution. We will try to review your Pull Request as quickly as possible. In the meantime, please take a look at the contribution guidelines if you have not done so already. |
|
CC @envoyproxy/api-shepherds: Your approval is needed for changes made to |
garimauttam
force-pushed
the
fix-43446-admin-gating-docs-main
branch
from
8b05a30 to
518df9a
Compare
garimauttam
temporarily deployed
to
external-contributors
GitHub Actions
Inactive
phlax
left a comment
phlax
left a comment
There was a problem hiding this comment.
thanks for working on this - really appreciated!
for the literalincludes - you can grep git grep literalinclude docs/ to see existing examples
in this case they can use the same bootstrap config
garimauttam
had a problem deploying
to
external-contributors
GitHub Actions
Error
garimauttam
had a problem deploying
to
external-contributors
GitHub Actions
Error
garimauttam
force-pushed
the
fix-43446-admin-gating-docs-main
branch
from
fecb6ed to
c4a082e
Compare
phlax
left a comment
phlax
left a comment
There was a problem hiding this comment.
really nice work - thanks for iterating ...
configs/admin-interface.yaml
Outdated
| protocol: TCP | ||
| address: 127.0.0.1 | ||
| port_value: 9901 | ||
| # docs_admin_address_snippet_end |
There was a problem hiding this comment.
in this case it renders - but im not sure its helpful
probably the better thing would be to highlight the allow_paths
docs/root/operations/admin.rst
Outdated
| .. literalinclude:: /_configs/repo/admin-interface.yaml | ||
| :language: yaml | ||
| :start-after: docs_admin_interface_snippet_start | ||
| :end-before: docs_admin_interface_snippet_end |
There was a problem hiding this comment.
hmm - i see - this is actually a lot better way than what we do now - nice touch
can we anchor off the actual content?
| socket_address: | ||
| address: 0.0.0.0 | ||
| port_value: 9901 | ||
| .. literalinclude:: /_configs/repo/admin-interface.yaml |
There was a problem hiding this comment.
its helpful for readers to be able to download the full file - if you check other literalincludes some/most have a caption/download
| Use ``prefix`` matchers for endpoints that are commonly queried with parameters (for example | ||
| ``/stats?filter=...``). | ||
|
|
||
| .. literalinclude:: /_configs/repo/admin-interface.yaml |
There was a problem hiding this comment.
Thanks for suggesting.
I removed the snippet marker comments, switched literalinclude anchors to real YAML content, added caption/download links for the included config, and highlighted allow_paths in the full include blocks.
Please review these changes.
Signed-off-by: garima-uttam <garimauttam@ibm.com>
Signed-off-by: garima-uttam <garimauttam@ibm.com>
Signed-off-by: garima-uttam <garimauttam@ibm.com>
Signed-off-by: garima-uttam <garimauttam@ibm.com>
Signed-off-by: garima-uttam <garimauttam@ibm.com>
garimauttam
force-pushed
the
fix-43446-admin-gating-docs-main
branch
from
71ae747 to
e34c654
Compare
adisuissa
left a comment
adisuissa
left a comment
There was a problem hiding this comment.
Thanks for improving the docs.
/lgtm api
3 participants
Fixes #43446.
Documents admin.allow_paths in quick-start and operations admin docs.
Adds practical gating examples for readiness checks (/ready) and query-based endpoints (/stats, /config_dump) using prefix matchers.
Updates Admin.allow_paths proto comments to reflect recommended matcher usage.
Docs-only change; no behavior change.