Skip to content

docs: Give a hint to specify type_url instead #14562

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

Merged
mattklein123 merged 3 commits into from
Jan 13, 2021
Merged

docs: Give a hint to specify type_url instead #14562

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eed94aa
docs: Give a hint to specify type_url instead
dio Jan 5, 2021
af13c29
Update link
dio Jan 11, 2021
d3e4328
Remove "."
dio Jan 11, 2021
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
18 changes: 15 additions & 3 deletions docs/root/configuration/listeners/listener_filters/tls_inspector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@ from the client. This can be used to select a
of a :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>`.

* :ref:`SNI <faq_how_to_setup_sni>`
* :ref:`v2 API reference <envoy_v3_api_field_config.listener.v3.ListenerFilter.name>`
* This filter should be configured with the name *envoy.filters.listener.tls_inspector*.
* :ref:`v3 API reference <envoy_v3_api_field_config.listener.v3.ListenerFilter.name>`
* This filter may be configured with the name *envoy.filters.listener.tls_inspector* or
*type.googleapis.com/envoy.extensions.listeners.tls_inspector.v3.TlsInspector* as the
`type_url <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any.FIELDS.string.google.protobuf.Any.type_url>`_.

Example
-------
Expand All @@ -29,10 +31,20 @@ A sample filter configuration could be:
- name: "envoy.filters.listener.tls_inspector"
typed_config: {}

Or by specifying the `type_url <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any.FIELDS.string.google.protobuf.Any.type_url>`_
of the *typed_config*:

.. code-block:: yaml

listener_filters:
- name: "tls_inspector"
typed_config:
"@type": type.googleapis.com/envoy.extensions.listeners.tls_inspector.v3.TlsInspector

Statistics
----------

This filter has a statistics tree rooted at *tls_inspector* with the following statistics:
This filter has a statistics tree rooted at *tls_inspector* with the following statistics:

.. csv-table::
:header: Name, Type, Description
Expand Down