Skip to content
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: fixes for release notes for 1.20 #18403

Merged
merged 6 commits into from
Oct 5, 2021
Merged
Changes from 1 commit
Commits
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
14 changes: 7 additions & 7 deletions docs/root/version_history/current.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Incompatible Behavior Changes
-----------------------------
*Changes that are expected to cause an incompatibility if applicable; deployment changes are likely required*

* config: the ``--bootstrap-version`` CLI flag has been removed, Envoy has only been able to accept v3
* config: the ``--bootstrap-version`` CLI flag has been removed, Envoy has been able to accept v3
bootstrap configurations since 1.18.0.
* contrib: the :ref:`squash filter <config_http_filters_squash>` has been moved to
:ref:`contrib images <install_contrib>`.
Expand All @@ -26,7 +26,6 @@ Incompatible Behavior Changes
Control planes upgrading from Envoy 1.19.0 and 1.19.1 will need to
vendor the corresponding protobuf definitions to ensure that the
renumbered fields have the types expected by those releases.
* ext_authz: fixed skipping authentication when returning either a direct response or a redirect. This behavior can be temporarily reverted by setting the ``envoy.reloadable_features.http_ext_authz_do_not_skip_direct_response_and_redirect`` runtime guard to false.
* extensions: deprecated extension names now default to triggering a configuration error.
The previous warning-only behavior may be temporarily reverted by setting the runtime key
``envoy.deprecated_features.allow_deprecated_extension_names`` to true.
Expand All @@ -35,9 +34,9 @@ Minor Behavior Changes
----------------------
*Changes that may cause incompatibilities for some users, but should not for most*

* client_ssl_auth filter: now sets additional termination details and **UAEX** response flag when the client certificate is not in the allowed-list.
* client_ssl_auth filter: now sets additional termination details and ``UAEX`` response flag when the client certificate is not in the allowed-list.
* config: configuration files ending in .yml now load as YAML.
* config: configuration file extensions now ignore case when deciding the file type. E.g., .JSON file load as JSON.
* config: configuration file extensions now ignore case when deciding the file type. E.g., .JSON files load as JSON.
* config: reduced log level for "Unable to establish new stream" xDS logs to debug. The log level
for "gRPC config stream closed" is now reduced to debug when the status is ``Ok`` or has been
retriable (``DeadlineExceeded``, ``ResourceExhausted``, or ``Unavailable``) for less than 30
Expand All @@ -50,6 +49,7 @@ Minor Behavior Changes
APIs that are known to be implicitly not work-in-progress have been force migrated and are
individually indicated elsewhere in the release notes. A server-wide ``wip_protos`` counter has
also been added in :ref:`server statistics <server_statistics>` to track this.
* ext_authz: fixed skipping authentication when returning either a direct response or a redirect. This behavior can be temporarily reverted by setting the ``envoy.reloadable_features.http_ext_authz_do_not_skip_direct_response_and_redirect`` runtime guard to false.
* grpc: gRPC async client can be cached and shared across filter instances in the same thread, this feature is turned off by default, can be turned on by setting runtime guard ``envoy.reloadable_features.enable_grpc_async_client_cache`` to true.
* http: correct the use of the ``x-forwarded-proto`` header and the ``:scheme`` header. Where they differ
(which is rare) ``:scheme`` will now be used for serving redirect URIs and cached content. This behavior
Expand All @@ -67,13 +67,13 @@ Minor Behavior Changes
feature to a non-negative number will override the default value.
* http: stop processing pending H/2 frames if connection transitioned to a closed state. This behavior can be temporarily reverted by setting the ``envoy.reloadable_features.skip_dispatching_frames_for_closed_connection`` to false.
* listener: added the :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>`
field and changed the default for reuse_port from false to true, as the feature is now well
field and changed the default for ``reuse_port`` from false to true, as the feature is now well
supported on the majority of production Linux kernels in use. The default change is aware of the hot
restart, as otherwise, the change would not be backward compatible between restarts. This means
that hot restarting onto a new binary will retain the default of false until the binary undergoes
a full restart. To retain the previous behavior, either explicitly set the new configuration
field to false, or set the runtime feature flag ``envoy.reloadable_features.listener_reuse_port_default_enabled``
to false. As part of this change, the use of reuse_port for TCP listeners on both macOS and
to false. As part of this change, the use of ``reuse_port`` for TCP listeners on both macOS and
Windows has been disabled due to suboptimal behavior. See the field documentation for more
information.
* listener: destroy per network filter chain stats when a network filter chain is removed during the listener in-place update.
Expand Down Expand Up @@ -138,7 +138,7 @@ New Features
* rbac: added :ref:`matcher<envoy_v3_api_field_config.rbac.v3.Permission.matcher>` along with extension category ``extension_category_envoy.rbac.matchers`` for custom RBAC permission matchers. Added reference implementation for matchers :ref:`envoy.rbac.matchers.upstream_ip_port <extension_envoy.rbac.matchers.upstream_ip_port>`.
* route config: added :ref:`dynamic_metadata <envoy_v3_api_field_config.route.v3.RouteMatch.dynamic_metadata>` for routing based on dynamic metadata.
* router: added retry options predicate extensions configured via
:ref:` <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_options_predicates>`. These
:ref:`<envoy_v3_api_field_config.route.v3.RetryPolicy.retry_options_predicates>`. These
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think you need to remove the <> around the link if there is no link text - im guessing that is what is causing the docs fail

extensions allow modification of requests between retries at the router level. There are not
currently any built-in extensions that implement this extension point.
* router: added :ref:`per_try_idle_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_idle_timeout>` timeout configuration.
Expand Down