-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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.
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
docs: mark matching API and related features as alpha #16210
Changes from 4 commits
7677de0
7f549fb
4a8325a
7c7b8d3
19d292b
1dc8ca4
57aa455
c5b2cd3
a4712bb
34290c9
4931d16
3684c37
7291160
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,11 @@ | |
Composite Filter | ||
================ | ||
|
||
.. attention:: | ||
|
||
The composite filter is experimental and is currently under active development. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. optional: experimental -> alpha here and below? |
||
Capabilities will be expanded over time and the configuration structures are likely to change. | ||
|
||
The composite filter allows delegating filter actions to a filter specified by a | ||
:ref:`match result <arch_overview_matching_api>`. The purpose of this is to allow different filters | ||
or filter configurations to be selected based on the incoming request, allowing for more dynamic | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,11 @@ | |
Matching API | ||
============ | ||
|
||
.. attention:: | ||
|
||
The matching API is experimental and is currently under active development. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: s/experimental/alpha/ |
||
Capabilities will be expanded over time and the configuration structures are likely to change. | ||
|
||
Envoy makes use of a :ref:`matching API <envoy_v3_api_msg_config.common.matcher.v3.Matcher>` | ||
to allow the various subsystems to express actions that should be performed based on incoming data. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -77,9 +77,10 @@ case, an extension will explicitly state this in its documentation. | |
Core and extensions | ||
------------------- | ||
|
||
Anything in the Envoy core may be used in both untrusted and trusted deployments. As a consequence, | ||
it should be hardened with this model in mind. Security issues related to core code will usually | ||
trigger the security release process as described in this document. | ||
Anything in the Envoy core may be used in both untrusted and trusted deployments, with the exception | ||
of features explicitly marked as experimental. As a consequence, it should be hardened with this model | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "marked as experimental; experimental features are only supported in trusted deployments and do not qualify for treatment under the threat model below" or something like that. |
||
in mind. Security issues related to core code will usually trigger the security release process as | ||
described in this document. | ||
|
||
The following extensions are intended to be hardened against untrusted downstream and upstreams: | ||
|
||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a
[#experimental:
tag and render this as a warning box? @phlax could you help @snowp with this if possible? It should be doable in https://github.com/envoyproxy/envoy/blob/main/tools/protodoc/protodoc.py.Also, can https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/threat_model#threat-model be updated to explicitly state anything flagged as experimental is out-of-scope?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is https://github.com/envoyproxy/envoy/pull/16210/files#diff-7e7afbba95a0599ef388b3eb10e44c6cf3520dd65c24ef0f8d77e790d683a537L80-R83 not sufficient for updating the threat model? Anywhere else I should point out that experimental features are not covered?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the cache filter probs wants to be marked as experimental too i think
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
apologies - i misread comment - i can help adding the annotation + parser if its helpful to