Skip to content

Commit fecb6ed

Browse files
committed
docs: literalinclude admin bootstrap examples
1 parent f24dba9 commit fecb6ed

File tree

2 files changed

+16
-33
lines changed

2 files changed

+16
-33
lines changed

docs/root/operations/admin.rst

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,10 @@ modify different aspects of the server:
2323
:ref:`allow_paths <envoy_v3_api_field_config.bootstrap.v3.Admin.allow_paths>`.
2424
This can be accomplished with a configuration like the following:
2525

26-
.. code-block:: yaml
27-
28-
admin:
29-
profile_path: /tmp/envoy.prof
30-
address:
31-
socket_address: { address: 127.0.0.1, port_value: 9901 }
32-
allow_paths:
33-
- exact: /ready
34-
- prefix: /stats
26+
.. literalinclude:: /_configs/repo/admin-interface.yaml
27+
:language: yaml
28+
:start-after: docs_admin_interface_snippet_start
29+
:end-before: docs_admin_interface_snippet_end
3530

3631
All mutations must be sent as HTTP POST operations. When a mutation is requested via GET,
3732
the request has no effect, and an HTTP 400 (Invalid Request) response is returned.

docs/root/start/quick-start/admin.rst

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,13 @@ The :ref:`admin message <envoy_v3_api_msg_config.bootstrap.v3.Admin>` is require
2727
the administration server.
2828

2929
The ``address`` key specifies the listening :ref:`address <envoy_v3_api_file_envoy/config/core/v3/address.proto>`
30-
which in the demo configuration is ``0.0.0.0:9901``.
30+
which in this example configuration is ``127.0.0.1:9901``.
3131

32-
In this example, the logs are simply discarded.
33-
34-
.. code-block:: yaml
35-
:emphasize-lines: 4-5
36-
37-
admin:
38-
address:
39-
socket_address:
40-
address: 0.0.0.0
41-
port_value: 9901
32+
.. literalinclude:: /_configs/repo/admin-interface.yaml
33+
:language: yaml
34+
:start-after: docs_admin_address_snippet_start
35+
:end-before: docs_admin_address_snippet_end
36+
:emphasize-lines: 5-6
4237

4338
.. warning::
4439

@@ -55,19 +50,12 @@ You can also restrict which admin endpoints are exposed using
5550
This is useful when the admin listener is used for limited purposes, such as a readiness probe.
5651

5752
Use ``prefix`` matchers for endpoints that are commonly queried with parameters (for example
58-
``/stats?filter=...`` or ``/config_dump?resource=...``).
59-
60-
.. code-block:: yaml
61-
62-
admin:
63-
address:
64-
socket_address:
65-
address: 127.0.0.1
66-
port_value: 9901
67-
allow_paths:
68-
- exact: /ready
69-
- prefix: /stats
70-
- prefix: /config_dump
53+
``/stats?filter=...``).
54+
55+
.. literalinclude:: /_configs/repo/admin-interface.yaml
56+
:language: yaml
57+
:start-after: docs_admin_interface_snippet_start
58+
:end-before: docs_admin_interface_snippet_end
7159

7260

7361
``stat_prefix``

0 commit comments

Comments
 (0)