From e2b966c896a8084ff4442e2895b5ed2ac86b6e52 Mon Sep 17 00:00:00 2001 From: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Date: Mon, 18 Mar 2024 19:06:39 -0400 Subject: [PATCH] docs: clarify LTS language (#20875) * docs: clarify LTS language --- website/content/docs/connect/proxies/envoy.mdx | 7 ++++--- .../docs/enterprise/long-term-support.mdx | 2 +- website/content/docs/upgrading/index.mdx | 17 ++++++++++------- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/website/content/docs/connect/proxies/envoy.mdx b/website/content/docs/connect/proxies/envoy.mdx index c04cebf506..19bfdd053d 100644 --- a/website/content/docs/connect/proxies/envoy.mdx +++ b/website/content/docs/connect/proxies/envoy.mdx @@ -33,8 +33,9 @@ Envoy must be run with the `--max-obj-name-len` option set to `256` or greater f 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 +- The latest (N) release of Consul community edition (CE) and Enterprise +- The 2 preceding major releases (N-1 and N-2) of Consul Enterprise +- The 2 latest [Consul Enterprise LTS](/consul/docs/enterprise/long-term-support) major releases For previous Consul version compatibility, refer to the previous release's version of this page. @@ -43,7 +44,7 @@ refer to the previous release's version of this page. 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) +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. diff --git a/website/content/docs/enterprise/long-term-support.mdx b/website/content/docs/enterprise/long-term-support.mdx index 5796c7a789..ff73a4cc92 100644 --- a/website/content/docs/enterprise/long-term-support.mdx +++ b/website/content/docs/enterprise/long-term-support.mdx @@ -35,7 +35,7 @@ as described in the following sections. ### Standard Term Support lifecycle -All major releases of Consul Enterprise and community edition receive _Standard Term Support_ (STS) +All major releases of Consul Enterprise receive _Standard Term Support_ (STS) for approximately one year, per HashiCorp's [Support Period Policy](https://support.hashicorp.com/hc/en-us/articles/360021185113-Support-Period-and-End-of-Life-EOL-Policy). diff --git a/website/content/docs/upgrading/index.mdx b/website/content/docs/upgrading/index.mdx index 8744088f22..50ef68deda 100644 --- a/website/content/docs/upgrading/index.mdx +++ b/website/content/docs/upgrading/index.mdx @@ -60,14 +60,18 @@ Consul is A, and version B is released. We encourage organizations to use a maintained version of Consul so that they benefit from bug and security fixes in minor releases. -Standard major releases of Consul are maintained for approximately 1 year. -Consul Enterprise [Long Term Support (LTS)](/consul/docs/enterprise/long-term-support) -releases are maintained for approximately 2 years. + +### Consul community edition For Consul community edition users, -consistently operating a maintained version requires a major version upgrade at least every 8 months. -Each upgrade can jump at most 2 major versions, and Consul has a major version release every 4 months. -Therefore, the maximum upgrade jump catches up on 8 months of major releases. +consistently operating a maintained version requires upgrading +every 4 months to the latest major release. + +### Consul Enterprise + +Standard major releases of Consul Enterprise are maintained for approximately 1 year. +[Consul Enterprise Long Term Support (LTS)](/consul/docs/enterprise/long-term-support) +releases are maintained for approximately 2 years. For Consul Enterprise customers, consistently operating a maintained version requires a major upgrade every 12 months @@ -76,7 +80,6 @@ LTS releases support an upgrade jump of at most 3 major versions. For more details, refer to [Long Term Support upgrade recommendation](/consul/docs/enterprise/long-term-support#annual-upgrade-to-next-lts-release). - ## Large Version Jumps If your Consul deployment is many major versions behind the latest release