diff --git a/api/API_VERSIONING.md b/api/API_VERSIONING.md index 52b0ea04c751..25e80aaa8407 100644 --- a/api/API_VERSIONING.md +++ b/api/API_VERSIONING.md @@ -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 @@ -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. diff --git a/docs/root/faq/api/envoy_v2_support.rst b/docs/root/faq/api/envoy_v2_support.rst new file mode 100644 index 000000000000..f9a2f9778646 --- /dev/null +++ b/docs/root/faq/api/envoy_v2_support.rst @@ -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 `. + diff --git a/docs/root/faq/overview.rst b/docs/root/faq/overview.rst index b3d9de193235..c3a32d963c52 100644 --- a/docs/root/faq/overview.rst +++ b/docs/root/faq/overview.rst @@ -17,6 +17,7 @@ API .. toctree:: :maxdepth: 2 + api/envoy_v2_support api/envoy_v3 api/envoy_upgrade_v3 api/extensions