Skip to content

Commit

Permalink
docs: Add Consul Enterprise LTS docs (#20720)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jkirschner-hashicorp
jkirschner-hashicorp authored Feb 26, 2024
1 parent 670ee90 commit 3ee926e
Show file tree
Hide file tree
Showing 11 changed files with 1,862 additions and 111 deletions.
109 changes: 93 additions & 16 deletions website/content/docs/connect/proxies/envoy.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,29 +31,106 @@ Envoy must be run with the `--max-obj-name-len` option set to `256` or greater f

## Supported Versions

The following matrix describes Envoy compatibility for the currently supported **n-2 major Consul releases**. For previous Consul version compatibility please view the respective versioned docs for this page.
The following matrix describes Envoy compatibility for the
currently supported major Consul releases:
- The N-2 major releases
- The 2 latest Consul Enterprise LTS major releases

For previous Consul version compatibility,
refer to the previous release's version of this page.

### Envoy and Consul Client Agent

Consul supports **four major Envoy releases** at the beginning of each major Consul release. Consul maintains compatibility with Envoy patch releases for each major version so that users can benefit from bug and security fixes in Envoy. As a policy, Consul will add support for a new major versions of Envoy in a Consul major release. Support for newer versions of Envoy will not be added to existing releases.
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.

| Consul Version | Compatible Envoy Versions |
| ------------------------------- | -----------------------------------------------------------------------------------|
| 1.18.x | 1.28.1, 1.27.3, 1.26.7, 1.25.11 |
| 1.17.x | 1.27.3, 1.26.7, 1.25.11, 1.24.12 |
| 1.16.x | 1.26.7, 1.25.11, 1.24.12, 1.23.12 |
| 1.15.x (LTS - Enterprise only) | 1.28.1, 1.27.3, 1.26.7, 1.25.11, 1.26.7, 1.25.11, 1.24.12, 1.23.12 |
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.

### Envoy and Consul Dataplane
#### Standard releases

Unless otherwise noted, rows in the following compatibility table
apply to both Consul Enterprise and Consul community edition (CE).

| Consul Version | Compatible Envoy Versions |
| -------------- | -------------------------------------- |
| 1.18.x CE | 1.28.1, 1.27.3, 1.26.7, 1.25.11 |
| 1.17.x | 1.27.3, 1.26.7, 1.25.11, 1.24.12 |
| 1.16.x | 1.26.7, 1.25.11, 1.24.12, 1.23.12 |

The Consul dataplane component was introduced in Consul v1.14 as a way to manage Envoy proxies without the use of Consul clients. Each new minor version of Consul is released with a new minor version of Consul dataplane, which packages both Envoy and the `consul-dataplane` binary in a single container image. For backwards compatibility reasons, each new minor version of Consul will also support the previous minor version of Consul dataplane to allow for seamless upgrades. In addition, each minor version of Consul will support the next minor version of Consul dataplane to allow for extended dataplane support via newer versions of Envoy.
#### Enterprise Long Term Support releases

Active Consul Enterprise
[Long Term Support (LTS)](/consul/docs/enterprise/long-term-support)
releases expand their Envoy version compatibility window
until the LTS release reaches its end of maintenance.

| Consul Version | Compatible Envoy Versions |
| -------------- | -----------------------------------------------------------------------------------|
| 1.18.x Ent | 1.28.1, 1.27.3, 1.26.7, 1.25.11 |
| 1.15.x Ent | 1.28.1, 1.27.3, 1.26.7, 1.25.11, 1.24.12, 1.23.12, 1.22.11 |

### Envoy and Consul Dataplane

| Consul Version | Default `consul-dataplane` Version | Other compatible `consul-dataplane` Versions |
| ------------------------------ | -------------------------------------|----------------------------------------------|
| 1.18.x | 1.4.x (Envoy 1.28.x) | 1.3.x (Envoy 1.27.x) |
| 1.17.x | 1.3.x (Envoy 1.27.x) | 1.4.x (Envoy 1.28.x), 1.2.x (Envoy 1.26.x) |
| 1.16.x | 1.2.x (Envoy 1.26.x) | 1.3.x (Envoy 1.27.x), 1.1.x (Envoy 1.25.x) |
| 1.15.x (LTS - Enterprise only) | 1.1.x (Envoy 1.25.x) | 1.2.x (Envoy 1.26.x), 1.0.x (Envoy 1.24.x) |
The Consul dataplane component was introduced in Consul v1.14
as a way to manage Envoy proxies without the use of Consul clients.

Each major version of Consul is released with a new major version of Consul dataplane,
which packages both Envoy and the `consul-dataplane` binary in a single container image.
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):
Active Consul Enterprise LTS releases expand their Consul dataplane
version compatibility window until the LTS release reaches its
end of maintenance.
- [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.

#### Standard releases

Unless otherwise noted, rows in the following compatibility table
apply to both Consul Enterprise and Consul community edition (CE).

| Consul Version | Default `consul-dataplane` Version | Other compatible `consul-dataplane` Versions |
| -------------- | -------------------------------------|----------------------------------------------|
| 1.18.x CE | 1.4.x (Envoy 1.28.x) | 1.3.x (Envoy 1.27.x) |
| 1.17.x | 1.3.x (Envoy 1.27.x) | 1.4.x (Envoy 1.28.x), 1.2.x (Envoy 1.26.x) |
| 1.16.x | 1.2.x (Envoy 1.26.x) | 1.3.x (Envoy 1.27.x), 1.1.x (Envoy 1.25.x) |

#### Enterprise Long Term Support releases

Active Consul Enterprise
[Long Term Support (LTS)](/consul/docs/enterprise/long-term-support)
releases expand their Envoy version compatibility window
until the LTS release reaches its end of maintenance.

| Consul Version | Default `consul-dataplane` Version | Other compatible `consul-dataplane` Versions |
| -------------- | -------------------------------------|----------------------------------------------|
| 1.18.x Ent | 1.4.x (Envoy 1.28.x) | 1.3.x (Envoy 1.27.x) |
| 1.15.x Ent | 1.1.x (Envoy 1.26.x) | 1.4.x (Envoy 1.28.x) - 1.0.x (Envoy 1.24.x) |

#### 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.

| `consul-dataplane` Version Range | Associated Consul Enterprise LTS version | Contained Envoy Binary Version |
| -------------------------------- | ---------------------------------------- | ------------------------------ |
| 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.1.0 - 1.1.8 | 1.15.x Ent | Envoy 1.25.x |

## Getting Started

Expand Down
Loading

0 comments on commit 3ee926e

Please sign in to comment.