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

Jump to bottom

docs: clarify Envoy and dataplane LTS support policy #21337

Merged
merged 1 commit into from
Oct 17, 2024
Merged

docs: clarify Envoy and dataplane LTS support policy #21337

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
40 changes: 23 additions & 17 deletions website/content/docs/connect/proxies/envoy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,12 @@ refer to the previous release's version of this page.
### Envoy and Consul Client Agent

Every major Consul release initially supports **four major Envoy releases**.
Standard major Consul releases do not expand that support in minor releases.
However, [Consul Enterprise Long Term Support (LTS)](/consul/docs/enterprise/long-term-support)
releases do expand their Envoy version compatibility window in minor releases
to ensure compatibility with a maintained Envoy version.
releases expand their Envoy version compatibility window in minor releases to
ensure compatibility with a maintained Envoy version. Standard (non-LTS) Consul
Enterprise releases may also expand support to a new major version of Envoy in
order to receive important security fixes, if the previous major Envoy version
has reached end-of-life.

Every major Consul release maintains and tests compatibility with specific Envoy
patch releases to ensure users can benefit from bug and security fixes in Envoy.
Expand Down Expand Up @@ -85,18 +87,18 @@ which packages both Envoy and the `consul-dataplane` binary in a single containe
To enable seamless upgrades, each major version of Consul also supports
the previous and next Consul dataplane versions.

Compared to standard Consul releases, Consul Enterprise
[Long Term Support (LTS)](/consul/docs/enterprise/long-term-support)
releases have the following differences with Consul dataplane compatibility:
- [Expanded compatibility window](#enterprise-long-term-support-releases):
Compared to community edition releases, Consul Enterprise releases have
the following differences with Consul dataplane compatibility:
- [LTS-Only: Expanded compatibility window](#enterprise-long-term-support-releases):
Active Consul Enterprise LTS releases expand their Consul dataplane
version compatibility window until the LTS release reaches its
end of maintenance.
version compatibility window to include the version of Consul dataplane
aligned with the next Consul LTS release.
- [Maintained Envoy version](#consul-dataplane-releases-that-span-envoy-major-versions):
Major versions of Consul dataplane aligned with a Consul Enterprise LTS version
may contain minor version updates that use a new major version of Envoy.
These minor version updates are necessary to ensure maintained versions
of Consul dataplane use a maintained version of Envoy.
Major versions of Consul dataplane aligned with a maintained Consul
Enterprise version may contain minor version updates that use a new
major version of Envoy. These minor version updates are necessary to
ensure that maintained versions of Consul dataplane use a maintained
version of Envoy.

#### Standard releases

Expand Down Expand Up @@ -125,16 +127,20 @@ until the LTS release reaches its end of maintenance.

#### Consul dataplane releases that span Envoy major versions

Major versions of Consul dataplane aligned with a Consul Enterprise LTS version
Major versions of Consul dataplane aligned with active versions of Consul
may contain minor version updates that use a new major version of Envoy.
These minor version updates are necessary to ensure maintained versions
of Consul dataplane use a maintained version of Envoy.
of Consul dataplane use a maintained version of Envoy including important
security fixes.

| `consul-dataplane` Version Range | Associated Consul Enterprise LTS version | Contained Envoy Binary Version |
| `consul-dataplane` Version Range | Associated Consul Enterprise version | Contained Envoy Binary Version |
| -------------------------------- | ---------------------------------------- | ------------------------------ |
| 1.5.0 - 1.5.latest | 1.18.x Ent | Envoy 1.29.x |
| 1.4.0 - 1.4.latest | 1.18.x Ent | Envoy 1.28.x |
| 1.1.9 - 1.1.latest | 1.15.x Ent | Envoy 1.26.x |
| 1.2.0 - 1.2.latest | 1.18.x Ent | Envoy 1.27.x |
| 1.2.0 - 1.2.7 | 1.18.x Ent | Envoy 1.27.x |
| 1.1.11 - 1.1.latest | 1.15.x Ent | Envoy 1.27.x |
| 1.1.9 - 1.1.10 | 1.15.x Ent | Envoy 1.26.x |
| 1.1.0 - 1.1.8 | 1.15.x Ent | Envoy 1.25.x |

## Getting Started
Expand Down
Loading