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.

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

api: clarify that v2 is removed at EOY 2020 regardless. #11083

Merged
merged 1 commit into from
May 6, 2020
Merged

api: clarify that v2 is removed at EOY 2020 regardless. #11083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions api/API_VERSIONING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,9 @@ Envoy will support at most three major versions of any API package at all times:
* The previous stable major version, e.g. v2. This is needed to ensure that we provide at least 1
year for a supported major version to sunset. By supporting two stable major versions
simultaneously, this makes it easier to coordinate control plane and Envoy
rollouts as well. This previous stable major version will be supported for 1
year after the introduction of the new current stable major version.
rollouts as well. This previous stable major version will be supported for exactly 1
year after the introduction of the new current stable major version, after which it will be
removed from the Envoy implementation.
* Optionally, the next experimental alpha major version, e.g. v4alpha. This is a release candidate
for the next stable major version. This is only generated when the current stable major version
requires a breaking change at the next cycle, e.g. a deprecation or field rename. This release
Expand All @@ -113,7 +114,8 @@ major version and support for `envoy.config.bootstrap.v2` will be dropped from t
implementation. Note that some transitively referenced package, e.g.
`envoy.config.filter.network.foo.v2` may remain at version 2 during this release, if no changes were
made to the referenced package. If no major version is justified at this point, the decision to cut
v4 might occur at some point in 2021 or beyond.
v4 might occur at some point in 2021 or beyond, however v2 support will still be removed at the end
of 2020.

The implication of this API lifecycle and clock is that any deprecated feature in the Envoy API will
retain implementation support for at least 1-2 years.
Expand Down
6 changes: 6 additions & 0 deletions docs/root/faq/api/envoy_v2_support.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
How long will the v2 APIs be supported?
=======================================

The v2 xDS APIs are deprecated and will be removed form Envoy at the end of 2020, as per the
:repo:`API versioning policy </api/API_VERSIONING.md>`.

1 change: 1 addition & 0 deletions docs/root/faq/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ API
.. toctree::
:maxdepth: 2

api/envoy_v2_support
api/envoy_v3
api/envoy_upgrade_v3
api/extensions
Expand Down