Skip to content

Commit 6f258de

Browse files
authored
changelog: fix typos in the current changelogs and clean them up (#40219)
This PR fixes the typos in the current changelogs and makes them more consistent. --------- Signed-off-by: Rohit Agrawal <[email protected]>
1 parent 86b1f30 commit 6f258de

File tree

1 file changed

+57
-55
lines changed

1 file changed

+57
-55
lines changed

changelogs/current.yaml

Lines changed: 57 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -10,39 +10,40 @@ behavior_changes:
1010
- area: prefix_match_map
1111
change: |
1212
:ref:`prefix_match_map <envoy_v3_api_field_config.common.matcher.v3.Matcher.MatcherTree.prefix_match_map>`
13-
now continues to search for a match with shorter prefix if a longer match
13+
now continues to search for a match with a shorter prefix if a longer match
1414
does not find an action. This brings it in line with the behavior of ``matcher_list``.
1515
This change can temporarily be reverted by setting the runtime guard
1616
``envoy.reloadable_features.prefix_map_matcher_resume_after_subtree_miss`` to ``false``.
1717
If the old behavior is desired more permanently, this can be achieved in config by setting
18-
an ``on_no_match`` action that responds with 404 for each subtree.
18+
an ``on_no_match`` action that responds with ``404`` for each subtree.
1919
- area: server
2020
change: |
2121
Envoy will automatically raise the soft limit on the file descriptors to the hard limit. This behavior
2222
can be reverted using the runtime guard ``envoy_restart_features_raise_file_limits``.
2323
- area: build
2424
change: |
25-
Removed the clang-libstdc++ toolchain setup as this is no longer used or tested by the project.
26-
Consolidated clang and gcc toolchains which can be used with ``--config=clang`` or ``--config=gcc``.
27-
These use libc++ and libstdc++ respectively.
25+
Removed the ``clang-libstdc++`` toolchain setup as this is no longer used or tested by the project.
26+
Consolidated Clang and GCC toolchains which can be used with ``--config=clang`` or ``--config=gcc``.
27+
These use ``libc++`` and ``libstdc++`` respectively.
2828
- area: squash_filter
2929
change: |
30-
The squash http filter in ``contrib`` has been deleted. The project it provided integration with has been idle for five years
31-
and appears abandoned.
30+
The Squash HTTP filter in ``contrib`` has been deleted. The project it provided integration with has been idle for
31+
five years and appears abandoned.
3232
3333
minor_behavior_changes:
3434
# *Changes that may cause incompatibilities for some users, but should not for most*
3535
- area: geoip
3636
change: |
37-
The lookup for asn information is fetched from ``asn_db`` if asn_db_path is defined and from ``isb_db`` if asn_db_path is not defined.
37+
The lookup for ASN information is fetched from ``asn_db`` if ``asn_db_path`` is defined and from ``isp_db`` if
38+
``asn_db_path`` is not defined.
3839
- area: lua
3940
change: |
40-
The ``metadata()`` of lua filter now will search the metadata by the :ref:`filter config name
41+
The ``metadata()`` of the Lua filter now will search the metadata by the :ref:`filter config name
4142
<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>` first.
4243
And if not found, it will search by the canonical name of the filter ``envoy.filters.http.lua``.
4344
- area: grpc-json
4445
change: |
45-
Make the :ref:`gRPC JSON transcoder filter's <config_http_filters_grpc_json_reverse_transcoder>` JSON print options configurable.
46+
Made the :ref:`gRPC JSON transcoder filter's <config_http_filters_grpc_json_reverse_transcoder>` JSON print options configurable.
4647
- area: oauth2
4748
change: |
4849
Reset CSRF token when token validation fails during redirection.
@@ -66,23 +67,23 @@ minor_behavior_changes:
6667
:ref:`dns_cache_config <envoy_v3_api_field_extensions.filters.http.dynamic_forward_proxy.v3.FilterConfig.dns_cache_config>`.
6768
- area: grpc-json-transcoding
6869
change: |
69-
Add SSE style message framing for streamed responses in :ref:`gRPC JSON transcoder filter <config_http_filters_grpc_json_transcoder>`.
70+
Added SSE style message framing for streamed responses in :ref:`gRPC JSON transcoder filter <config_http_filters_grpc_json_transcoder>`.
7071
- area: http
7172
change: |
72-
:ref:`response_headers_to_add <envoy_v3_api_field_config.route.v3.Route.response_headers_to_add>` and
73-
:ref:`response_headers_to_remove <envoy_v3_api_field_config.route.v3.Route.response_headers_to_remove>`
74-
will also be applied to the local responses from the ``envoy.filters.http.router`` filter.
73+
:ref:`response_headers_to_add <envoy_v3_api_field_config.route.v3.Route.response_headers_to_add>` and
74+
:ref:`response_headers_to_remove <envoy_v3_api_field_config.route.v3.Route.response_headers_to_remove>`
75+
will also be applied to the local responses from the ``envoy.filters.http.router`` filter.
7576
- area: tracing
7677
change: |
77-
Add :ref:`max_cache_size <envoy_v3_api_field_config.trace.v3.OpenTelemetryConfig.max_cache_size>`
78+
Added :ref:`max_cache_size <envoy_v3_api_field_config.trace.v3.OpenTelemetryConfig.max_cache_size>`
7879
to the OpenTelemetry tracer config. This limits the number of spans that can be cached before flushing.
7980
- area: aws
8081
change: |
8182
:ref:`AwsCredentialProvider <envoy_v3_api_msg_extensions.common.aws.v3.AwsCredentialProvider>` now supports all defined credential
82-
providers, allowing complete customisation of the credential provider chain when using AWS request signing extension.
83+
providers, allowing complete customization of the credential provider chain when using AWS request signing extension.
8384
- area: ext_proc
8485
change: |
85-
If ext_proc server sends spurious response message to Envoy, Envoy now performs fail-open or fail-close action based on
86+
If the ext_proc server sends a spurious response message to Envoy, Envoy now performs fail-open or fail-close action based on
8687
:ref:`failure_mode_allow <envoy_v3_api_field_extensions.filters.http.ext_proc.v3.ExternalProcessor.failure_mode_allow>`
8788
configuration. This change can be reverted by setting the runtime guard
8889
``envoy.reloadable_features.ext_proc_fail_close_spurious_resp`` to ``false``.
@@ -92,15 +93,15 @@ minor_behavior_changes:
9293
a work in progress field.
9394
- area: oauth2
9495
change: |
95-
The access token, id token and refresh token in the cookies are now encrypted using the HMAC secret. This behavior can
96+
The access token, ID token and refresh token in the cookies are now encrypted using the HMAC secret. This behavior can
9697
be reverted by setting the runtime guard ``envoy.reloadable_features.oauth2_encrypt_tokens`` to ``false``.
9798
- area: http3
9899
change: |
99-
Validate HTTP/3 pseudo headers. Can be disabled by setting ``envoy.restart_features.validate_http3_pseudo_headers`` to false.
100+
Validate HTTP/3 pseudo headers. Can be disabled by setting ``envoy.restart_features.validate_http3_pseudo_headers`` to ``false``.
100101
- area: formatter
101102
change: |
102-
Now the ``METADATA`` and ``CEL`` substitution formatters could access or log the metadata of
103-
virtual host in case the route is not matched but the virtual host is found.
103+
Now the ``METADATA`` and ``CEL`` substitution formatters can access or log the metadata of
104+
the virtual host in case the route is not matched but the virtual host is found.
104105
- area: oauth2
105106
change: |
106107
Extension status changed from ``alpha`` to ``stable``.
@@ -111,7 +112,7 @@ bug_fixes:
111112
change: |
112113
Fixed an issue that could lead to too many connections when using
113114
:ref:`AutoHttpConfig <envoy_v3_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions.AutoHttpConfig>` if the
114-
established connection is ``http/2`` and Envoy predicted it would have lower concurrent capacity.
115+
established connection is HTTP/2 and Envoy predicted it would have lower concurrent capacity.
115116
- area: conn_pool
116117
change: |
117118
Fixed an issue that could lead to insufficient connections for current pending requests. If a connection starts draining while it
@@ -122,40 +123,40 @@ bug_fixes:
122123
for a long time.
123124
- area: hcm
124125
change: |
125-
Fixes a bug where the lifetime of the ``HttpConnectionManager``'s ``ActiveStream`` can be out of sync
126+
Fixed a bug where the lifetime of the ``HttpConnectionManager``'s ``ActiveStream`` can be out of sync
126127
with the lifetime of the codec stream.
127128
- area: config_validation
128129
change: |
129-
Fixed an bug where the config validation server will crash when the configuration contains
130+
Fixed a bug where the config validation server will crash when the configuration contains
130131
``%CEL%`` or ``%METADATA%`` substitution formatter.
131132
- area: tls
132133
change: |
133134
Fixed an issue with incorrectly cached connection properties on TLS connections.
134135
If TLS connection data was queried before it was available, an empty value was being incorrectly cached, preventing later calls from
135136
getting the correct value. This could be triggered with a ``tcp_proxy`` access log configured to emit a log upon connection
136-
establishment if the log contains fields of the the TLS peer certificate. Then a later use of the data, such as the network RBAC
137+
establishment if the log contains fields of the TLS peer certificate. Then a later use of the data, such as the network RBAC
137138
filter validating a peer certificate SAN, may incorrectly fail due to the empty cached value.
138139
- area: quic
139140
change: |
140-
Fixes a bug in Envoy's HTTP/3-to-HTTP/1 proxying when a ``transfer-encoding`` header is incorrectly appended.
141+
Fixed a bug in Envoy's HTTP/3-to-HTTP/1 proxying when a ``transfer-encoding`` header is incorrectly appended.
141142
Protected by runtime guard ``envoy.reloadable_features.quic_signal_headers_only_to_http1_backend``.
142143
- area: runtime
143144
change: |
144-
Fixed a bug which resulted in an ENVOY_BUG being incorrectly triggered when runtime settings
145+
Fixed a bug which resulted in an ``ENVOY_BUG`` being incorrectly triggered when runtime settings
145146
``envoy.reloadable_features.max_request_headers_count``, ``envoy.reloadable_features.max_response_headers_count``,
146147
``envoy.reloadable_features.max_request_headers_size_kb``, or ``envoy.reloadable_features.max_response_headers_size_kb`` were set.
147148
- area: tls
148149
change: |
149-
Fixes a bug where empty trusted CA file or inline string is accepted and causes Envoy to successfully validate any certificate
150+
Fixed a bug where empty trusted CA file or inline string is accepted and causes Envoy to successfully validate any certificate
150151
chain. This fix addresses this issue by rejecting such configuration with empty value. This behavior can be reverted by setting
151152
the runtime guard ``envoy.reloadable_features.reject_empty_trusted_ca_file`` to ``false``.
152153
- area: tls_inspector
153154
change: |
154-
Fixes a bug where the TLS inspector filter would not correctly report ``client_hello_too_large`` stat for too big client hello messages
155-
i.e bigger than 16kb.
155+
Fixed a bug where the TLS inspector filter would not correctly report ``client_hello_too_large`` stat for too big client
156+
hello messages, i.e., bigger than 16 KB.
156157
- area: wasm
157158
change: |
158-
Fixed a bug where the WASM filter will hangs when the VM is crashed in the request callbacks.
159+
Fixed a bug where the Wasm filter hangs when the VM is crashed in the request callbacks.
159160
160161
removed_config_or_runtime:
161162
# *Normally occurs at the end of the* :ref:`deprecation period <deprecated>`
@@ -208,24 +209,24 @@ new_features:
208209
Upgraded Envoy to build with C++20; Envoy developers can use C++20 features now.
209210
- area: redis
210211
change: |
211-
Added support for ``scan`` and ``info``.
212+
Added support for ``SCAN`` and ``INFO``.
212213
- area: http
213214
change: |
214215
Added :ref:`x-envoy-original-host <config_http_filters_router_x-envoy-original-host>` that
215216
is used to record the original host header value before it is mutated by the router filter.
216217
- area: stateful_session
217218
change: |
218-
Supports envelope stateful session extension to keep the existing session header value
219+
Support for envelope stateful session extension to keep the existing session header value
219220
from upstream server. See :ref:`mode
220221
<envoy_v3_api_msg_extensions.http.stateful_session.envelope.v3.EnvelopeSessionState>`
221222
for more details.
222-
- area: transport tap
223+
- area: transport_tap
223224
change: |
224-
Add counter in transport tap for streaming and buffer trace.
225-
streamed trace can sent tapped message based on configured size.
226-
- area: udp sink
225+
Added counter in transport tap for streaming and buffer trace.
226+
Streamed trace can send tapped message based on configured size.
227+
- area: udp_sink
227228
change: |
228-
Enhance udp sink to support the single message which the size is bigger than 64K.
229+
Enhanced UDP sink to support a single message whose size is bigger than 64 KB.
229230
- area: load_balancing
230231
change: |
231232
Added Override Host Load Balancing policy. See
@@ -252,15 +253,15 @@ new_features:
252253
Added ``grpc_status`` to ``ExtAuthzLoggingInfo`` in ``ext_authz`` HTTP filter.
253254
- area: http
254255
change: |
255-
Add :ref:`response trailers mutations
256+
Added :ref:`response trailers mutations
256257
<envoy_v3_api_field_extensions.filters.http.header_mutation.v3.Mutations.response_trailers_mutations>` and
257258
:ref:`request trailers mutations
258259
<envoy_v3_api_field_extensions.filters.http.header_mutation.v3.Mutations.request_trailers_mutations>`
259260
to :ref:`Header Mutation Filter <envoy_v3_api_msg_extensions.filters.http.header_mutation.v3.HeaderMutation>`
260261
for adding/removing trailers from the request and the response.
261262
- area: postgres
262263
change: |
263-
added support for requiring downstream SSL.
264+
Added support for requiring downstream SSL.
264265
- area: url_template
265266
change: |
266267
Included the asterisk ``*`` in the match pattern when using the ``*`` or ``**`` operators in the URL template.
@@ -269,13 +270,13 @@ new_features:
269270
- area: socket
270271
change: |
271272
Added ``network_namespace_filepath`` to ``SocketAddress``. Currently only used by listeners.
272-
- area: rbac filter
273+
- area: rbac_filter
273274
change: |
274-
Allow listed ``FilterStateInput`` to be used with the xDS matcher in the HTTP RBAC filter.
275-
- area: rbac filter
275+
Allow-listed ``FilterStateInput`` to be used with the xDS matcher in the HTTP RBAC filter.
276+
- area: rbac_filter
276277
change: |
277-
Allow listed ``FilterStateInput`` to be used with the xDS matcher in the Network RBAC filter.
278-
- area: tls_inspector filter
278+
Allow-listed ``FilterStateInput`` to be used with the xDS matcher in the Network RBAC filter.
279+
- area: tls_inspector_filter
279280
change: |
280281
Added :ref:`enable_ja4_fingerprinting
281282
<envoy_v3_api_field_extensions.filters.listener.tls_inspector.v3.TlsInspector.enable_ja4_fingerprinting>` to create
@@ -293,16 +294,16 @@ new_features:
293294
be logged out of the Authorization server.
294295
- area: tcp_access_logs
295296
change: |
296-
Added support for %BYTES_RECEIVED%, %BYTES_SENT%, %UPSTREAM_HEADER_BYTES_SENT%, %UPSTREAM_HEADER_BYTES_RECEIVED%,
297-
%UPSTREAM_WIRE_BYTES_SENT%, %UPSTREAM_WIRE_BYTES_RECEIVED% access log substitution strings for TCP tunneling flows.
297+
Added support for ``%BYTES_RECEIVED%``, ``%BYTES_SENT%``, ``%UPSTREAM_HEADER_BYTES_SENT%``, ``%UPSTREAM_HEADER_BYTES_RECEIVED%``,
298+
``%UPSTREAM_WIRE_BYTES_SENT%``, ``%UPSTREAM_WIRE_BYTES_RECEIVED%`` access log substitution strings for TCP tunneling flows.
298299
- area: oauth2
299300
change: |
300301
Added configurable :ref:`csrf_token_expires_in
301302
<envoy_v3_api_field_extensions.filters.http.oauth2.v3.OAuth2Config.csrf_token_expires_in>`
302303
and :ref:`code_verifier_token_expires_in
303304
<envoy_v3_api_field_extensions.filters.http.oauth2.v3.OAuth2Config.code_verifier_token_expires_in>`
304305
fields to the ``oauth2`` filter. Both default to ``600s`` (10 minutes) if not specified, keeping backward compatibility.
305-
- area: load shed point
306+
- area: load_shed_point
306307
change: |
307308
Added load shed point ``envoy.load_shed_points.connection_pool_new_connection`` in the connection pool, and it will not
308309
create new connections when Envoy is under pressure, and the pending downstream requests will be cancelled.
@@ -314,7 +315,7 @@ new_features:
314315
before forwarding.
315316
- area: lua
316317
change: |
317-
Added a new ``dynamicTypedMetadata()`` on ``connectionStreamInfo()`` which could be used to access the typed metadata from
318+
Added a new ``dynamicTypedMetadata()`` on ``connectionStreamInfo()`` which can be used to access the typed metadata from
318319
network filters, such as the Proxy Protocol, etc.
319320
- area: aws
320321
change: |
@@ -332,16 +333,16 @@ new_features:
332333
- area: router
333334
change: |
334335
Added new ``refreshRouteCluster()`` method to stream filter callbacks to support refreshing the route cluster and
335-
need not to update the route cache. See :ref:`http route mutation <arch_overview_http_filters_route_mutation>` for
336+
does not need to update the route cache. See :ref:`http route mutation <arch_overview_http_filters_route_mutation>` for
336337
more details.
337338
- area: lua
338339
change: |
339-
Added a new ``dynamicTypedMetadata()`` on ``streamInfo()`` which could be used to access the typed metadata from
340+
Added a new ``dynamicTypedMetadata()`` on ``streamInfo()`` which can be used to access the typed metadata from
340341
HTTP filters, such as the Set Metadata filter, etc.
341342
- area: ratelimit
342343
change: |
343-
Added a new ``failure_mode_deny_percent`` field of type ``Envoy::Runtime::FractionalPercent`` attached to the rate limit filter
344-
to configure the failure mode for rate limit service errors in runtime.
344+
Added a new ``failure_mode_deny_percent`` field of type ``Envoy::Runtime::FractionalPercent`` attached to the rate
345+
limit filter to configure the failure mode for rate limit service errors in runtime.
345346
It acts as an override for the existing ``failure_mode_deny`` field in the filter config.
346347
- area: tls
347348
change: |
@@ -354,13 +355,14 @@ new_features:
354355
setting may now be overridden on a per-route basis.
355356
- area: matcher
356357
change: |
357-
added support for :ref:`ServerNameMatcher <envoy_v3_api_msg_.xds.type.matcher.v3.ServerNameMatcher>` trie-based matching.
358+
Added support for :ref:`ServerNameMatcher <envoy_v3_api_msg_.xds.type.matcher.v3.ServerNameMatcher>` trie-based matching.
358359
- area: stateful_session
359360
change: |
360361
Added support for cookie attributes to stateful session cookie.
361362
- area: http3
362363
change: |
363-
Added envoy_v3_api_field_extensions.upstreams.http.v3.Http3ProtocolOptions.disable_connection_flow_control_for_streams, an experimental
364+
Added :ref:`disable_connection_flow_control_for_streams
365+
<envoy_v3_api_field_config.core.v3.Http3ProtocolOptions.disable_connection_flow_control_for_streams>`, an experimental
364366
option for disabling connection level flow control for streams. This is useful in situations where the streams share the same
365367
connection but originate from different end-clients, so that each stream can make progress independently at non-front-line proxies.
366368
- area: dfp

0 commit comments

Comments
 (0)