From bc9bb1c5ce3ad66830426e333f6b434350f40f0a Mon Sep 17 00:00:00 2001 From: Jeff-Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Sun, 17 Apr 2022 16:57:32 -0700 Subject: [PATCH 01/12] Initial changes for reoranizing the Release Notes --- .../consul-api-gateway/v0_1_0.mdx | 43 +++++++++++++++++++ .../consul/v1_10_x.mdx} | 4 +- .../consul/v1_11_x.mdx} | 12 +++--- .../consul/v1_9_x.mdx} | 4 +- website/content/docs/release-notes/index.mdx | 12 ++++++ website/content/docs/releases/index.mdx | 10 ----- .../docs/releases/release-notes/index.mdx | 12 ------ website/data/docs-nav-data.json | 29 +++++++------ 8 files changed, 85 insertions(+), 41 deletions(-) create mode 100644 website/content/docs/release-notes/consul-api-gateway/v0_1_0.mdx rename website/content/docs/{releases/release-notes/v1_10_0.mdx => release-notes/consul/v1_10_x.mdx} (97%) rename website/content/docs/{releases/release-notes/v1_11_0.mdx => release-notes/consul/v1_11_x.mdx} (95%) rename website/content/docs/{releases/release-notes/v1_9_0.mdx => release-notes/consul/v1_9_x.mdx} (97%) create mode 100644 website/content/docs/release-notes/index.mdx delete mode 100644 website/content/docs/releases/index.mdx delete mode 100644 website/content/docs/releases/release-notes/index.mdx diff --git a/website/content/docs/release-notes/consul-api-gateway/v0_1_0.mdx b/website/content/docs/release-notes/consul-api-gateway/v0_1_0.mdx new file mode 100644 index 0000000000..df8efaaebd --- /dev/null +++ b/website/content/docs/release-notes/consul-api-gateway/v0_1_0.mdx @@ -0,0 +1,43 @@ +--- +layout: docs +page_title: 0.1.0 +description: >- + Consul API Gateway release notes for version 0.1.0 +--- + + +# Consul API Gateway 0.1.0 + +## Release Highlights + +This is the first Generally Available (GA) release of Consul API Gateway. + +1. **Supported Runtimes:** Kubernetes - self managed, AWS EKS, Google GKE and Azure AKS. +1. Install via the HashiCorp Consul Helm chart. +1. Works with self-managed Consul servers and HCP Consul servers +1. Configure via Kubernetes Gateway API - v1alpha2 +1. Deploy 1 or more logical API Gateways per Kubernetes cluster +1. Deploy 1 or more instances (a.k.a. pods) per logical API Gateway +1. Supported protocols: HTTP, HTTPS, TCP +1. Supported HTTP versions: 1.1 & 2 +1. Load balance across a service’s instances +1. HTTPS Listeners load TLS certificates, signed by an CA, from Kubernetes Secret Storage +1. Route HTTP/S traffic to Services based on matching: + - Hostname + - URI Path + - HTTP Header + - HTTP Method + - HTTP Query parameters + - HTTP Header manipulation: +1. Set header value + - Add header and/or value + - Remove header and/or value +1. TLS settings configurable per Listener: + - Set minimum allowed TLS version + - Enabled cipher-suites (a.k.a. Cipher string) +1. Route to services in different Name Spaces +1. Split traffic across multiple services, based on weight +1. Support multi-runtime service mesh deployments + - The Consul API Gateway must be running on Kubernetes but it can route traffic to services running outside of K8s as long the service is connected to the Consul service mesh. + +For more detailed information, please refer to the [product documentation](/docs/api-gateway). diff --git a/website/content/docs/releases/release-notes/v1_10_0.mdx b/website/content/docs/release-notes/consul/v1_10_x.mdx similarity index 97% rename from website/content/docs/releases/release-notes/v1_10_0.mdx rename to website/content/docs/release-notes/consul/v1_10_x.mdx index 5cadcbc262..7dfb18ac26 100644 --- a/website/content/docs/releases/release-notes/v1_10_0.mdx +++ b/website/content/docs/release-notes/consul/v1_10_x.mdx @@ -1,6 +1,8 @@ --- layout: docs -page_title: 1.10.0 +page_title: 1.10.x +description: >- + Consul release notes for version 1.10.x --- # Consul 1.10.0 diff --git a/website/content/docs/releases/release-notes/v1_11_0.mdx b/website/content/docs/release-notes/consul/v1_11_x.mdx similarity index 95% rename from website/content/docs/releases/release-notes/v1_11_0.mdx rename to website/content/docs/release-notes/consul/v1_11_x.mdx index d2b80b6983..a0e26cddf8 100644 --- a/website/content/docs/releases/release-notes/v1_11_0.mdx +++ b/website/content/docs/release-notes/consul/v1_11_x.mdx @@ -1,6 +1,8 @@ --- layout: docs -page_title: 1.11.0 +page_title: 1.11.x +description: >- + Consul release notes for version 1.11.x --- # Consul 1.11.0 @@ -15,13 +17,13 @@ page_title: 1.11.0 - **TLS Certificates for Ingress Gateways via an SDS source:**: Ingress Gateways can now be configured to retrieve TLS certificates from an external SDS Service and load the TLS certificates for Ingress listeners. This configuration is set using the `ingress-gateway` configuration entry via the [SDS](/docs/connect/config-entries/ingress-gateway#sds) stanza within the Ingress Gateway TLS configuration. -- **Vault Auth Method support for Connect CA Vault Provider:** Consul now supports configuring the Connect CA Vault provider to use auth methods for authentication to Vault. Consul supports using any non-deprecated auth method that is available in Vault v1.8.5, including AppRole, AliCloud, AWS, Azure, Cloud Foundry, GitHub, Google Cloud, JWT/OIDC, Kerberos, Kubernetes, LDAP, Oracle Cloud Infrastructure, Okta, Radius, TLS Certificates, and Username & Password. The Vault Auth Method for Connect CA Provider is utilized by default for the [Vault Secrets Backend](/docs/k8s/installation/vault) feature on Consul on Kubernetes. Utilizing a Vault Auth method would no longer require a Vault token to be managed or provisioned ahead of time to be used for authentication to Vault. +- **Vault Auth Method support for Connect CA Vault Provider:** Consul now supports configuring the Connect CA Vault provider to use auth methods for authentication to Vault. Consul supports using any non-deprecated auth method that is available in Vault v1.8.5, including AppRole, AliCloud, AWS, Azure, Cloud Foundry, GitHub, Google Cloud, JWT/OIDC, Kerberos, Kubernetes, LDAP, Oracle Cloud Infrastructure, Okta, Radius, TLS Certificates, and Username & Password. The Vault Auth Method for Connect CA Provider is utilized by default for the [Vault Secrets Backend](/docs/k8s/installation/vault) feature on Consul on Kubernetes. Utilizing a Vault Auth method would no longer require a Vault token to be managed or provisioned ahead of time to be used for authentication to Vault. ## What's Changed - -- The legacy ACL system that was deprecated in Consul 1.4.0 has been removed. Before upgrading you should verify that all tokens and policies have been migrated to the newer ACL system. See the [Migrate Legacy ACL Tokens Learn Guide](https://learn.hashicorp.com/tutorials/consul/access-control-token-migration) for more information. -- The `agent_master` ACL token has been renamed to `agent_recovery` ACL token. In addition, the `consul acl set-agent-token master` command has been replaced with `consul acl set-agent-token recovery`. See [ACL Agent Recovery Token](/docs/security/acl/acl-system#acl-agent-recovery-token) and [Consul ACL Set Agent Token](/commands/acl/set-agent-token) for more information. +- The legacy ACL system that was deprecated in Consul 1.4.0 has been removed. Before upgrading you should verify that all tokens and policies have been migrated to the newer ACL system. See the [Migrate Legacy ACL Tokens Learn Guide](https://learn.hashicorp.com/tutorials/consul/access-control-token-migration) for more information. + +- The `agent_master` ACL token has been renamed to `agent_recovery` ACL token. In addition, the `consul acl set-agent-token master` command has been replaced with `consul acl set-agent-token recovery`. See [ACL Agent Recovery Token](/docs/security/acl/acl-system#acl-agent-recovery-token) and [Consul ACL Set Agent Token](/commands/acl/set-agent-token) for more information. - Drops support for Envoy versions 1.15.x and 1.16.x diff --git a/website/content/docs/releases/release-notes/v1_9_0.mdx b/website/content/docs/release-notes/consul/v1_9_x.mdx similarity index 97% rename from website/content/docs/releases/release-notes/v1_9_0.mdx rename to website/content/docs/release-notes/consul/v1_9_x.mdx index 6d9c4b9aa5..b2d851c641 100644 --- a/website/content/docs/releases/release-notes/v1_9_0.mdx +++ b/website/content/docs/release-notes/consul/v1_9_x.mdx @@ -1,6 +1,8 @@ --- layout: docs -page_title: 1.9.0 +page_title: 1.9.x +description: >- + Consul release notes for version 1.9.x --- # Consul 1.9.0 diff --git a/website/content/docs/release-notes/index.mdx b/website/content/docs/release-notes/index.mdx new file mode 100644 index 0000000000..d879a5fa3d --- /dev/null +++ b/website/content/docs/release-notes/index.mdx @@ -0,0 +1,12 @@ +--- +layout: docs +page_title: Release Notes +description: |- + Release notes for the major software packages in the Consul product line +--- + +# Release Notes + +Use the navigation panel, to the left, to see the Release Notes for each of the major software packages in the Consul product line + +Documentation for maintenance releases (e.g., 0.1.x) is available at the [Consul changelog](https://github.com/hashicorp/consul/blob/main/CHANGELOG.md). diff --git a/website/content/docs/releases/index.mdx b/website/content/docs/releases/index.mdx deleted file mode 100644 index 0dae705918..0000000000 --- a/website/content/docs/releases/index.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -layout: docs -page_title: Releases -description: |- - Consul releases ---- - -# Downloads - -Downloads of Consul can be found on the [HashiCorp Release Page](https://github.com/hashicorp/consul/releases/). diff --git a/website/content/docs/releases/release-notes/index.mdx b/website/content/docs/releases/release-notes/index.mdx deleted file mode 100644 index 839fe0bd28..0000000000 --- a/website/content/docs/releases/release-notes/index.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: docs -page_title: Release Notes -description: |- - Consul release notes ---- - -# Release Notes - -The side bar to the left has release notes for all major releases of Consul. - -Documentation for patch releases (0.1.x) is available at the [Consul changelog](https://github.com/hashicorp/consul/blob/main/CHANGELOG.md). diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 1538aa9aca..f2fdee71c2 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -1194,30 +1194,35 @@ ] }, { - "title": "Releases", + "title": "Release Notes", "routes": [ { "title": "Overview", - "path": "releases" + "path": "release-notes" }, { - "title": "Release Notes", + "title": "Consul", "routes": [ { - "title": "Overview", - "path": "releases/release-notes" + "title": "v1.11.x", + "path": "release-notes/consul/v1_11_x" }, { - "title": "v1.11.0", - "path": "releases/release-notes/v1_11_0" + "title": "v1.10.x", + "path": "release-notes/consul/v1_10_x" }, { - "title": "v1.10.0", - "path": "releases/release-notes/v1_10_0" - }, + "title": "v1.9.x", + "path": "release-notes/consul/v1_9_x" + } + ] + }, + { + "title": "Consul API Gateway", + "routes": [ { - "title": "v1.9.0", - "path": "releases/release-notes/v1_9_0" + "title": "v0.1.0", + "path": "release-notes/consul-api-gateway/v0_1_0" } ] } From 280b8bddf9cdc4b9f38a0a9018ac14df78226557 Mon Sep 17 00:00:00 2001 From: Jeff-Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Thu, 21 Apr 2022 16:49:01 -0700 Subject: [PATCH 02/12] Add template for consul-k8s release notes. --- .../docs/release-notes/consul-k8s/0.43.x.mdx | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 website/content/docs/release-notes/consul-k8s/0.43.x.mdx diff --git a/website/content/docs/release-notes/consul-k8s/0.43.x.mdx b/website/content/docs/release-notes/consul-k8s/0.43.x.mdx new file mode 100644 index 0000000000..b3ca39a47b --- /dev/null +++ b/website/content/docs/release-notes/consul-k8s/0.43.x.mdx @@ -0,0 +1,48 @@ +--- +layout: docs +page_title: 0.43.x +description: >- + Consul Kubernetes release notes for version 1.11.x +--- + +# Consul 1.11.0 + +## Release Highlights + +- **Name of Highlight :** Describe it here + +- **Name of Highlight :** Describe it here + +- **Name of Highlight :** Describe it here + +## What's Changed + +- First change + +- Second change + +- Third change + +## Support Software Versions + +- Consul: +- Kubernetes: +- Kubectl: + +## Upgrading + + + +For detailed information on upgrading, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-11-0) + +## Change logs + +The change log for this Major release is listed below. When Maintenance versions +are released, links to their change logs will be added here. + +[1.11.0 changelog](https://github.com/hashicorp/consul-k8s/releases/tag/v0.43.0). From b3126e1190e30d8de6429ebe175012aae4872382 Mon Sep 17 00:00:00 2001 From: Jeff-Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Fri, 22 Apr 2022 12:15:09 -0700 Subject: [PATCH 03/12] Adding Rel Notes for ECS and moved CTS one. --- .../content/docs/nia/release-notes/index.mdx | 12 ----- .../docs/release-notes/consul-ecs/v0_2_x.mdx | 49 +++++++++++++++++++ .../docs/release-notes/consul-ecs/v0_3_x.mdx | 49 +++++++++++++++++++ .../docs/release-notes/consul-ecs/v0_4_x.mdx | 49 +++++++++++++++++++ .../consul-k8s/{0.43.x.mdx => v0_43_x.mdx} | 0 .../consul-terraform-sync/v0_5_x.mdx} | 4 +- website/data/docs-nav-data.json | 48 +++++++++++++----- website/redirects.js | 26 ++++++++-- 8 files changed, 207 insertions(+), 30 deletions(-) delete mode 100644 website/content/docs/nia/release-notes/index.mdx create mode 100644 website/content/docs/release-notes/consul-ecs/v0_2_x.mdx create mode 100644 website/content/docs/release-notes/consul-ecs/v0_3_x.mdx create mode 100644 website/content/docs/release-notes/consul-ecs/v0_4_x.mdx rename website/content/docs/release-notes/consul-k8s/{0.43.x.mdx => v0_43_x.mdx} (100%) rename website/content/docs/{nia/release-notes/0-5-0.mdx => release-notes/consul-terraform-sync/v0_5_x.mdx} (99%) diff --git a/website/content/docs/nia/release-notes/index.mdx b/website/content/docs/nia/release-notes/index.mdx deleted file mode 100644 index f6936d891a..0000000000 --- a/website/content/docs/nia/release-notes/index.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: docs -page_title: Release Notes -description: |- - Consul-Terraform-Sync release notes ---- - -# Release Notes - -The side bar to the left has release notes for all major releases of CTS. - -Documentation for patch releases is available at the [Consul-Terraform-Sync changelog](https://github.com/hashicorp/consul-terraform-sync/blob/main/CHANGELOG.md). diff --git a/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx new file mode 100644 index 0000000000..bbcbfcb29f --- /dev/null +++ b/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx @@ -0,0 +1,49 @@ +--- +layout: docs +page_title: 0.4.x +description: >- + Consul ECS release notes for version 0.4.x +--- + +# Consul ECS 0.4.0 + +## Release Highlights + +- **Name of Highlight :** Describe it here + +- **Name of Highlight :** Describe it here + +- **Name of Highlight :** Describe it here + +## What's Changed + +- First change + +- Second change + +- Third change + +## Support Software Versions + +- Consul: +- Kubernetes: +- Kubectl: + +## Upgrading + + + +For detailed information on upgrading, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-11-0) + +## Change logs + +The change log for this Major release is listed below. When Maintenance versions +are released, links to their change logs will be added here. + +[0.4.0 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.0) +[0.4.1 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.1) diff --git a/website/content/docs/release-notes/consul-ecs/v0_3_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_3_x.mdx new file mode 100644 index 0000000000..bbcbfcb29f --- /dev/null +++ b/website/content/docs/release-notes/consul-ecs/v0_3_x.mdx @@ -0,0 +1,49 @@ +--- +layout: docs +page_title: 0.4.x +description: >- + Consul ECS release notes for version 0.4.x +--- + +# Consul ECS 0.4.0 + +## Release Highlights + +- **Name of Highlight :** Describe it here + +- **Name of Highlight :** Describe it here + +- **Name of Highlight :** Describe it here + +## What's Changed + +- First change + +- Second change + +- Third change + +## Support Software Versions + +- Consul: +- Kubernetes: +- Kubectl: + +## Upgrading + + + +For detailed information on upgrading, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-11-0) + +## Change logs + +The change log for this Major release is listed below. When Maintenance versions +are released, links to their change logs will be added here. + +[0.4.0 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.0) +[0.4.1 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.1) diff --git a/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx new file mode 100644 index 0000000000..bbcbfcb29f --- /dev/null +++ b/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx @@ -0,0 +1,49 @@ +--- +layout: docs +page_title: 0.4.x +description: >- + Consul ECS release notes for version 0.4.x +--- + +# Consul ECS 0.4.0 + +## Release Highlights + +- **Name of Highlight :** Describe it here + +- **Name of Highlight :** Describe it here + +- **Name of Highlight :** Describe it here + +## What's Changed + +- First change + +- Second change + +- Third change + +## Support Software Versions + +- Consul: +- Kubernetes: +- Kubectl: + +## Upgrading + + + +For detailed information on upgrading, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-11-0) + +## Change logs + +The change log for this Major release is listed below. When Maintenance versions +are released, links to their change logs will be added here. + +[0.4.0 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.0) +[0.4.1 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.1) diff --git a/website/content/docs/release-notes/consul-k8s/0.43.x.mdx b/website/content/docs/release-notes/consul-k8s/v0_43_x.mdx similarity index 100% rename from website/content/docs/release-notes/consul-k8s/0.43.x.mdx rename to website/content/docs/release-notes/consul-k8s/v0_43_x.mdx diff --git a/website/content/docs/nia/release-notes/0-5-0.mdx b/website/content/docs/release-notes/consul-terraform-sync/v0_5_x.mdx similarity index 99% rename from website/content/docs/nia/release-notes/0-5-0.mdx rename to website/content/docs/release-notes/consul-terraform-sync/v0_5_x.mdx index 14dda1ca4a..13c1119977 100644 --- a/website/content/docs/nia/release-notes/0-5-0.mdx +++ b/website/content/docs/release-notes/consul-terraform-sync/v0_5_x.mdx @@ -1,8 +1,8 @@ --- layout: docs -page_title: CTS v0.5.0 +page_title: CTS v0.5.x description: >- - Consul-Terraform-Sync release notes for v0.5.0 + Consul-Terraform-Sync release notes for v0.5.x --- -> The release notes for v0.5.0 focus on a subset of configuration deprecations diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index f2fdee71c2..2edf5afe1b 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -846,19 +846,6 @@ { "title": "Compatibility", "path": "nia/compatibility" - }, - { - "title": "Release Notes", - "routes": [ - { - "title": "Overview", - "path": "nia/release-notes" - }, - { - "title": "v0.5.0", - "path": "nia/release-notes/0-5-0" - } - ] } ] }, @@ -1225,6 +1212,41 @@ "path": "release-notes/consul-api-gateway/v0_1_0" } ] + }, + { + "title": "Consul ECS", + "routes": [ + { + "title": "v0.4.x", + "path": "release-notes/consul-ecs/v0_4_x" + }, + { + "title": "v0.3.x", + "path": "release-notes/consul-ecs/v0_3_x" + }, + { + "title": "v0.2.x", + "path": "release-notes/consul-ecs/v0_2_x" + } + ] + }, + { + "title": "Consul K8s", + "routes": [ + { + "title": "v0.43.x", + "path": "release-notes/consul-k8s/v0_43_x" + } + ] + }, + { + "title": "Consul Terraform Sync", + "routes": [ + { + "title": "v0.5.x", + "path": "release-notes/consul-terraform-sync/v0_5_x" + } + ] } ] }, diff --git a/website/redirects.js b/website/redirects.js index ae62677041..beb09f8e56 100644 --- a/website/redirects.js +++ b/website/redirects.js @@ -1246,17 +1246,17 @@ module.exports = [ }, { source: '/docs/release-notes/1-11-0', - destination: '/docs/releases/release-notes/v1_11_0', + destination: '/docs/release-notes/consul/v1_11_x', permanent: true, }, { source: '/docs/release-notes/1-10-0', - destination: '/docs/releases/release-notes/v1_10_0', + destination: '/docs/release-notes/consul/v1_10_x', permanent: true, }, { source: '/docs/release-notes/1-9-0', - destination: '/docs/releases/release-notes/v1_9_0', + destination: '/docs/release-notes/consul/v1_9_x', permanent: true, }, { @@ -1269,4 +1269,24 @@ module.exports = [ destination: '/docs/agent/config', permanent: true, }, + { + source: '/docs/releases/release-notes/v1_11_0', + destination: '/docs/release-notes/consul/v1_11_x', + permanent: true, + }, + { + source: '/docs/release-notes/1-10-0', + destination: '/docs/release-notes/consul/v1_10_x', + permanent: true, + }, + { + source: '/docs/release-notes/1-9-0', + destination: '/docs/release-notes/consul/v1_9_x', + permanent: true, + }, + { + source: '/docs/nia/release-notes/:path', + destination: '/docs/release-notes/consul-terraform-sync/:path', + permanent: true, + }, ] From 132a54ba144bb11a9d7db9901885f0ac801dd6d2 Mon Sep 17 00:00:00 2001 From: Jeff Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Fri, 22 Apr 2022 14:38:33 -0700 Subject: [PATCH 04/12] Update v0_4_x.mdx --- website/content/docs/release-notes/consul-ecs/v0_4_x.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx index bbcbfcb29f..bb16b9ee2d 100644 --- a/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx +++ b/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx @@ -46,4 +46,5 @@ The change log for this Major release is listed below. When Maintenance versions are released, links to their change logs will be added here. [0.4.0 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.0) + [0.4.1 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.1) From d56a695be7352b7707674b987ab103fc329a3d44 Mon Sep 17 00:00:00 2001 From: Jeff-Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Mon, 25 Apr 2022 20:59:18 -0700 Subject: [PATCH 05/12] Docs: Release Notes reorg - adding ECS and NIA --- .../content/docs/api-gateway/tech-specs.mdx | 15 ++-- .../consul-api-gateway/v0_1_0.mdx | 43 ----------- .../consul-api-gateway/v0_1_x.mdx | 72 +++++++++++++++++++ .../docs/release-notes/consul-ecs/v0_2_x.mdx | 43 +++-------- .../docs/release-notes/consul-ecs/v0_3_x.mdx | 43 +++-------- .../docs/release-notes/consul-ecs/v0_4_x.mdx | 38 +++------- .../docs/release-notes/consul-k8s/v0_43_x.mdx | 48 ------------- .../docs/release-notes/consul/v1_10_x.mdx | 20 +++++- .../docs/release-notes/consul/v1_11_x.mdx | 15 +++- .../docs/release-notes/consul/v1_9_x.mdx | 27 ++++++- website/content/docs/release-notes/index.mdx | 2 +- website/data/docs-nav-data.json | 13 +--- website/redirects.js | 4 +- 13 files changed, 170 insertions(+), 213 deletions(-) delete mode 100644 website/content/docs/release-notes/consul-api-gateway/v0_1_0.mdx create mode 100644 website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx delete mode 100644 website/content/docs/release-notes/consul-k8s/v0_43_x.mdx diff --git a/website/content/docs/api-gateway/tech-specs.mdx b/website/content/docs/api-gateway/tech-specs.mdx index 20ff2a1f8d..3414460db1 100644 --- a/website/content/docs/api-gateway/tech-specs.mdx +++ b/website/content/docs/api-gateway/tech-specs.mdx @@ -28,7 +28,7 @@ Your datacenter must meet the following requirements prior to configuring the Co The following table describes the TCP port requirements for each component of the API Gateway. | Port | Description | Component | -| ---- | ----------- | --------- | +| ---- | ----------- | --------- | | 9090 | Secret discovery service (SDS) | Gateway controller pod
Gateway instance pod | | 20000 | Kubernetes readiness probe | Gateway instance pod | | Configurable | Port for scraping Prometheus metrics. Disabled by default. | Gateway controller pod | @@ -49,10 +49,9 @@ Consul API Gateway can be deployed in the following Kubernetes-based environment - Google Kubernetes Engine (GKE) - Azure Kubernetes Service (AKS) -## Kubernetes Gateway API Specification - -Supported version of the Gateway API spec: v1alpha2 +## Kubernetes Gateway API Specification - Supported Versions +See the Release Notes for the version of Consul API Gateway being used. ## Resource Allocations @@ -60,10 +59,10 @@ The following resources are allocated for each component of the API Gateway. ### Gateway Controller Pod -* **CPU**: None. Either the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration. -* **Memory**: None. Either the the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration. +- **CPU**: None. Either the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration. +- **Memory**: None. Either the the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration. ### Gateway Instance Pod -* **CPU**: None. Either the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration. -* **Memory**: None. Either the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration. \ No newline at end of file +- **CPU**: None. Either the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration. +- **Memory**: None. Either the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration. diff --git a/website/content/docs/release-notes/consul-api-gateway/v0_1_0.mdx b/website/content/docs/release-notes/consul-api-gateway/v0_1_0.mdx deleted file mode 100644 index df8efaaebd..0000000000 --- a/website/content/docs/release-notes/consul-api-gateway/v0_1_0.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: docs -page_title: 0.1.0 -description: >- - Consul API Gateway release notes for version 0.1.0 ---- - - -# Consul API Gateway 0.1.0 - -## Release Highlights - -This is the first Generally Available (GA) release of Consul API Gateway. - -1. **Supported Runtimes:** Kubernetes - self managed, AWS EKS, Google GKE and Azure AKS. -1. Install via the HashiCorp Consul Helm chart. -1. Works with self-managed Consul servers and HCP Consul servers -1. Configure via Kubernetes Gateway API - v1alpha2 -1. Deploy 1 or more logical API Gateways per Kubernetes cluster -1. Deploy 1 or more instances (a.k.a. pods) per logical API Gateway -1. Supported protocols: HTTP, HTTPS, TCP -1. Supported HTTP versions: 1.1 & 2 -1. Load balance across a service’s instances -1. HTTPS Listeners load TLS certificates, signed by an CA, from Kubernetes Secret Storage -1. Route HTTP/S traffic to Services based on matching: - - Hostname - - URI Path - - HTTP Header - - HTTP Method - - HTTP Query parameters - - HTTP Header manipulation: -1. Set header value - - Add header and/or value - - Remove header and/or value -1. TLS settings configurable per Listener: - - Set minimum allowed TLS version - - Enabled cipher-suites (a.k.a. Cipher string) -1. Route to services in different Name Spaces -1. Split traffic across multiple services, based on weight -1. Support multi-runtime service mesh deployments - - The Consul API Gateway must be running on Kubernetes but it can route traffic to services running outside of K8s as long the service is connected to the Consul service mesh. - -For more detailed information, please refer to the [product documentation](/docs/api-gateway). diff --git a/website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx b/website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx new file mode 100644 index 0000000000..eaea2f6b64 --- /dev/null +++ b/website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx @@ -0,0 +1,72 @@ +--- +layout: docs +page_title: 0.1.x +description: >- + Consul API Gateway release notes for version 0.1.x +--- + + +# Consul API Gateway 0.1.0 + +## OVerview + +This is the first General Availability (GA) release of Consul API Gateway. It +provides controlled access for network traffic, from outside a Consul service +mesh, to Services on the mesh + +In Kubernetes deployments, it can be used as an alternative to Consul's Ingress +Gateway and provides capabilities Ingress Gateway does not. These include: + +1. It allows you to configure and deploy new gateways at any time, without + rerunning the Consul Helm chart. The configuration of a running gateway can + be changed dynamically at anytime, usually without disrupting any the the + traffic flowing through it. +1. Listeners on a gateway can use TLS server certificates signed by any + Certificate Authority (CA). This allows you to use certificates from public + CA's, like Verisign and Let's Encrypt, and private CA's, such as a company's + internal CA. + +## Release Highlights + +1. **Supported Runtimes:** Kubernetes - self managed, AWS EKS, Google GKE and Azure AKS. +1. Install via the HashiCorp Consul Helm chart. +1. Works with self-managed Consul servers and HCP Consul servers +1. Configure via Kubernetes Gateway API - v1alpha2 +1. Deploy 1 or more logical API Gateways per Kubernetes cluster +1. Supported protocols: HTTP, HTTPS, TCP, TCP+TLS +1. Supported HTTP versions: 1.1 & 2 +1. Load balance across a service’s instances +1. Listeners load TLS certificates, signed by any CA, from Kubernetes Secret Storage +1. Route HTTP/S traffic to Services based on matching: + - Hostname + - URI Path + - HTTP Header + - HTTP Method + - HTTP Query parameters +1 HTTP Header manipulation: + - Set header value + - Add header and/or value + - Remove header and/or value +1. TLS settings configurable per Listener: + - Set minimum allowed TLS version + - Enabled cipher-suites (a.k.a. Cipher string) +1. Route to services in different Name Spaces +1. Split traffic across multiple services, based on weight +1. Support multi-runtime service mesh deployments + - The Consul API Gateway must be running on Kubernetes but it can route + traffic to services running outside of K8s as long the service is connected + to the Consul service mesh. + +## Supported Software - Minimum Versions + +- Consul: 1.11.2+ +- HashiCorp Consul Helm chart: 0.41.1+ +- Kubernetes: 1.21+ +- Kubectl: 1.21+ +- Envoy Proxy: Determined by the Consul version deployed + +## Kubernetes Gateway API Specification + +Supported version of the Gateway API spec: `v1alpha2`(v0.4.1) + +For more detailed information, please refer to the [product documentation](/docs/api-gateway). diff --git a/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx index bbcbfcb29f..322e528b4e 100644 --- a/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx +++ b/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx @@ -1,49 +1,26 @@ --- layout: docs -page_title: 0.4.x +page_title: 0.2.x description: >- - Consul ECS release notes for version 0.4.x + Consul ECS release notes for version 0.2.x --- -# Consul ECS 0.4.0 +# Consul ECS 0.2.0 ## Release Highlights -- **Name of Highlight :** Describe it here +- **Support Secure Deployment on ECS :** Enable gossip encryption and TLS for the Consul service mesh control plane. Add new ACL controller module and enable ACLs for other components. -- **Name of Highlight :** Describe it here - -- **Name of Highlight :** Describe it here - -## What's Changed - -- First change - -- Second change - -- Third change +- **Enable Consul Native Health Checks :** Add support for both Consul native and ECS health checks. Added health-sync container to default to either of the health checks based on if checks are defined and containers are essential. ## Support Software Versions -- Consul: -- Kubernetes: -- Kubectl: +- Consul: 1.10.x -## Upgrading +## Changelogs - +The changelogs for this Major release version and any Maintenance versions, are listed below. -For detailed information on upgrading, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-11-0) +-> These links will take you to the changelogs on the GitHub website. -## Change logs - -The change log for this Major release is listed below. When Maintenance versions -are released, links to their change logs will be added here. - -[0.4.0 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.0) -[0.4.1 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.1) +- [0.2.0](https://github.com/hashicorp/consul-ecs/releases/tag/v0.2.0) diff --git a/website/content/docs/release-notes/consul-ecs/v0_3_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_3_x.mdx index bbcbfcb29f..f1f7172a8d 100644 --- a/website/content/docs/release-notes/consul-ecs/v0_3_x.mdx +++ b/website/content/docs/release-notes/consul-ecs/v0_3_x.mdx @@ -1,49 +1,24 @@ --- layout: docs -page_title: 0.4.x +page_title: 0.3.x description: >- - Consul ECS release notes for version 0.4.x + Consul ECS release notes for version 0.3.x --- -# Consul ECS 0.4.0 +# Consul ECS 0.3.0 ## Release Highlights -- **Name of Highlight :** Describe it here - -- **Name of Highlight :** Describe it here - -- **Name of Highlight :** Describe it here - -## What's Changed - -- First change - -- Second change - -- Third change +- **Support file-based configuration :** All CLI flags and options can be passed via a JSON file. This feature also enables manual install of Consul on ECS. ## Support Software Versions -- Consul: -- Kubernetes: -- Kubectl: +- Consul: 1.10.x, 1.11.x -## Upgrading +## Changelogs - +The changelogs for this Major release version and any Maintenance versions, are listed below. -For detailed information on upgrading, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-11-0) +-> These links will take you to the changelogs on the GitHub website. -## Change logs - -The change log for this Major release is listed below. When Maintenance versions -are released, links to their change logs will be added here. - -[0.4.0 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.0) -[0.4.1 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.1) +- [0.3.0](https://github.com/hashicorp/consul-ecs/releases/tag/v0.3.0) diff --git a/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx index bb16b9ee2d..affd4a5025 100644 --- a/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx +++ b/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx @@ -9,42 +9,20 @@ description: >- ## Release Highlights -- **Name of Highlight :** Describe it here +- **Admin Partitions (Enterprise) :** This feature supports various deployment patterns that enable multiple ECS clusters from different tenants to share a single Consul control plane. -- **Name of Highlight :** Describe it here - -- **Name of Highlight :** Describe it here - -## What's Changed - -- First change - -- Second change - -- Third change +- **Namespaces (Enterprise) :** This feature enables autonomy across teams by allowing creation of isolated environments in shared clusters. ## Support Software Versions -- Consul: -- Kubernetes: -- Kubectl: +- Consul: 1.10.x, 1.11.x, 1.12.x -## Upgrading +## Changelogs - +The changelogs for this Major release version and any Maintenance versions, are listed below. -For detailed information on upgrading, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-11-0) +-> These links will take you to the changelogs on the GitHub website. -## Change logs +- [0.4.0](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.0) -The change log for this Major release is listed below. When Maintenance versions -are released, links to their change logs will be added here. - -[0.4.0 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.0) - -[0.4.1 changelog](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.1) +- [0.4.1](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.1) diff --git a/website/content/docs/release-notes/consul-k8s/v0_43_x.mdx b/website/content/docs/release-notes/consul-k8s/v0_43_x.mdx deleted file mode 100644 index b3ca39a47b..0000000000 --- a/website/content/docs/release-notes/consul-k8s/v0_43_x.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -layout: docs -page_title: 0.43.x -description: >- - Consul Kubernetes release notes for version 1.11.x ---- - -# Consul 1.11.0 - -## Release Highlights - -- **Name of Highlight :** Describe it here - -- **Name of Highlight :** Describe it here - -- **Name of Highlight :** Describe it here - -## What's Changed - -- First change - -- Second change - -- Third change - -## Support Software Versions - -- Consul: -- Kubernetes: -- Kubectl: - -## Upgrading - - - -For detailed information on upgrading, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-11-0) - -## Change logs - -The change log for this Major release is listed below. When Maintenance versions -are released, links to their change logs will be added here. - -[1.11.0 changelog](https://github.com/hashicorp/consul-k8s/releases/tag/v0.43.0). diff --git a/website/content/docs/release-notes/consul/v1_10_x.mdx b/website/content/docs/release-notes/consul/v1_10_x.mdx index 7dfb18ac26..c2a627f6be 100644 --- a/website/content/docs/release-notes/consul/v1_10_x.mdx +++ b/website/content/docs/release-notes/consul/v1_10_x.mdx @@ -24,4 +24,22 @@ description: >- - Drops support for Envoy version 1.13.x. - (Enterprise Only) Consul Enterprise has removed support for temporary licensing. All server agents must have a valid license at startup and client agents must have a license at startup or be able to retrieve one from the servers. -For more detailed information, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-10-0) and the [1.10.0 changelog](https://github.com/hashicorp/consul/releases/tag/v1.10.0). +For more detailed information, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-10-0) and the changelogs. + +## Changelogs + +The changelogs for this Major release version and any Maintenance versions, are listed below. + +-> These links will take you to the changelogs on the GitHub website. + +- [1.10.0](https://github.com/hashicorp/consul/releases/tag/v1.10.0) +- [1.10.1](https://github.com/hashicorp/consul/releases/tag/v1.10.1) +- [1.10.2](https://github.com/hashicorp/consul/releases/tag/v1.10.2) +- [1.10.3](https://github.com/hashicorp/consul/releases/tag/v1.10.3) +- [1.10.4](https://github.com/hashicorp/consul/releases/tag/v1.10.4) +- [1.10.5](https://github.com/hashicorp/consul/releases/tag/v1.10.5) +- [1.10.6](https://github.com/hashicorp/consul/releases/tag/v1.10.6) +- [1.10.7](https://github.com/hashicorp/consul/releases/tag/v1.10.7) +- [1.10.8](https://github.com/hashicorp/consul/releases/tag/v1.10.8) +- [1.10.9](https://github.com/hashicorp/consul/releases/tag/v1.10.9) +- [1.10.10](https://github.com/hashicorp/consul/releases/tag/v1.10.10) \ No newline at end of file diff --git a/website/content/docs/release-notes/consul/v1_11_x.mdx b/website/content/docs/release-notes/consul/v1_11_x.mdx index a0e26cddf8..d65376cff2 100644 --- a/website/content/docs/release-notes/consul/v1_11_x.mdx +++ b/website/content/docs/release-notes/consul/v1_11_x.mdx @@ -27,4 +27,17 @@ description: >- - Drops support for Envoy versions 1.15.x and 1.16.x -For more detailed information, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-11-0) and the [1.11.0 changelog](https://github.com/hashicorp/consul/releases/tag/v1.11.0). +For more detailed information, please refer to the [upgrade details page](/docs/upgrading/upgrade-specific#consul-1-11-0) and the changelogs. + +## Changelogs + +The changelogs for this Major release version and any Maintenance versions, are listed below. + +-> These links will take you to the changelogs on the GitHub website. + +- [1.11.0](https://github.com/hashicorp/consul/releases/tag/v1.11.0) +- [1.11.1](https://github.com/hashicorp/consul/releases/tag/v1.11.1) +- [1.11.2](https://github.com/hashicorp/consul/releases/tag/v1.11.2) +- [1.11.3](https://github.com/hashicorp/consul/releases/tag/v1.11.3) +- [1.11.4](https://github.com/hashicorp/consul/releases/tag/v1.11.4) +- [1.11.5](https://github.com/hashicorp/consul/releases/tag/v1.11.5) diff --git a/website/content/docs/release-notes/consul/v1_9_x.mdx b/website/content/docs/release-notes/consul/v1_9_x.mdx index b2d851c641..759125bb05 100644 --- a/website/content/docs/release-notes/consul/v1_9_x.mdx +++ b/website/content/docs/release-notes/consul/v1_9_x.mdx @@ -31,4 +31,29 @@ description: >- - Drops support for Envoy versions 1.12.0, 1.12.1, 1.12.2, and 1.13.0 - Switches the default gateway port from 443 to 8443 to avoid assumption of Envoy running as root. -For more detailed information, please refer to the [changelog](https://github.com/hashicorp/consul/blob/main/CHANGELOG.md#190-november-24-2020). +For more detailed information, please refer to the changelog + +## Changelogs + +The changelogs for this Major release version and any Maintenance versions, are listed below. + +-> These links will take you to the changelogs on the GitHub website. + +- [1.9.0](https://github.com/hashicorp/consul/releases/tag/v1.9.0) +- [1.9.1](https://github.com/hashicorp/consul/releases/tag/v1.9.1) +- [1.9.2](https://github.com/hashicorp/consul/releases/tag/v1.9.2) +- [1.9.3](https://github.com/hashicorp/consul/releases/tag/v1.9.3) +- [1.9.4](https://github.com/hashicorp/consul/releases/tag/v1.9.4) +- [1.9.5](https://github.com/hashicorp/consul/releases/tag/v1.9.5) +- [1.9.6](https://github.com/hashicorp/consul/releases/tag/v1.9.6) +- [1.9.7](https://github.com/hashicorp/consul/releases/tag/v1.9.7) +- [1.9.8](https://github.com/hashicorp/consul/releases/tag/v1.9.8) +- [1.9.9](https://github.com/hashicorp/consul/releases/tag/v1.9.9) +- [1.9.10](https://github.com/hashicorp/consul/releases/tag/v1.9.10) +- [1.9.11](https://github.com/hashicorp/consul/releases/tag/v1.9.11) +- [1.9.12](https://github.com/hashicorp/consul/releases/tag/v1.9.12) +- [1.9.13](https://github.com/hashicorp/consul/releases/tag/v1.9.13) +- [1.9.14](https://github.com/hashicorp/consul/releases/tag/v1.9.14) +- [1.9.15](https://github.com/hashicorp/consul/releases/tag/v1.9.15) +- [1.9.16](https://github.com/hashicorp/consul/releases/tag/v1.9.16) +- [1.9.17](https://github.com/hashicorp/consul/releases/tag/v1.9.17) diff --git a/website/content/docs/release-notes/index.mdx b/website/content/docs/release-notes/index.mdx index d879a5fa3d..74a56fd491 100644 --- a/website/content/docs/release-notes/index.mdx +++ b/website/content/docs/release-notes/index.mdx @@ -9,4 +9,4 @@ description: |- Use the navigation panel, to the left, to see the Release Notes for each of the major software packages in the Consul product line -Documentation for maintenance releases (e.g., 0.1.x) is available at the [Consul changelog](https://github.com/hashicorp/consul/blob/main/CHANGELOG.md). +Documentation for maintenance releases (e.g., 0.1.x) is added to the bottom of each Release Notes page. diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 2edf5afe1b..0ec76b42b5 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -1208,8 +1208,8 @@ "title": "Consul API Gateway", "routes": [ { - "title": "v0.1.0", - "path": "release-notes/consul-api-gateway/v0_1_0" + "title": "v0.1.x", + "path": "release-notes/consul-api-gateway/v0_1_x" } ] }, @@ -1230,15 +1230,6 @@ } ] }, - { - "title": "Consul K8s", - "routes": [ - { - "title": "v0.43.x", - "path": "release-notes/consul-k8s/v0_43_x" - } - ] - }, { "title": "Consul Terraform Sync", "routes": [ diff --git a/website/redirects.js b/website/redirects.js index beb09f8e56..0014d13b55 100644 --- a/website/redirects.js +++ b/website/redirects.js @@ -1285,8 +1285,8 @@ module.exports = [ permanent: true, }, { - source: '/docs/nia/release-notes/:path', - destination: '/docs/release-notes/consul-terraform-sync/:path', + source: '/docs/nia/release-notes/0-5-0', + destination: '/docs/release-notes/consul-terraform-sync/v0_5_x', permanent: true, }, ] From 9a228d2e62574f4d43b6add5a39030f0cf016c87 Mon Sep 17 00:00:00 2001 From: Jeff Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Tue, 26 Apr 2022 08:01:07 -0700 Subject: [PATCH 06/12] Update website/content/docs/release-notes/consul-ecs/v0_4_x.mdx Co-authored-by: Karl Cardenas --- website/content/docs/release-notes/consul-ecs/v0_4_x.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx index affd4a5025..cdb2d85f71 100644 --- a/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx +++ b/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx @@ -21,7 +21,7 @@ description: >- The changelogs for this Major release version and any Maintenance versions, are listed below. --> These links will take you to the changelogs on the GitHub website. +-> **Note**: These links will take you to the changelogs on the GitHub website. - [0.4.0](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.0) From 4f5ec017d6c489e159c830cb0744b89ef24a166c Mon Sep 17 00:00:00 2001 From: Jeff Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Tue, 26 Apr 2022 08:01:16 -0700 Subject: [PATCH 07/12] Update website/content/docs/release-notes/consul-ecs/v0_3_x.mdx Co-authored-by: Karl Cardenas --- website/content/docs/release-notes/consul-ecs/v0_3_x.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/release-notes/consul-ecs/v0_3_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_3_x.mdx index f1f7172a8d..a21ea9394f 100644 --- a/website/content/docs/release-notes/consul-ecs/v0_3_x.mdx +++ b/website/content/docs/release-notes/consul-ecs/v0_3_x.mdx @@ -19,6 +19,6 @@ description: >- The changelogs for this Major release version and any Maintenance versions, are listed below. --> These links will take you to the changelogs on the GitHub website. +-> **Note**: These links will take you to the changelogs on the GitHub website. - [0.3.0](https://github.com/hashicorp/consul-ecs/releases/tag/v0.3.0) From d2463fd431699ca2d154e291e4499bfd421d2609 Mon Sep 17 00:00:00 2001 From: Jeff Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Tue, 26 Apr 2022 08:01:45 -0700 Subject: [PATCH 08/12] Update website/content/docs/release-notes/consul-ecs/v0_2_x.mdx Co-authored-by: Karl Cardenas --- website/content/docs/release-notes/consul-ecs/v0_2_x.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx index 322e528b4e..0700504334 100644 --- a/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx +++ b/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx @@ -21,6 +21,6 @@ description: >- The changelogs for this Major release version and any Maintenance versions, are listed below. --> These links will take you to the changelogs on the GitHub website. +-> **Note**: These links will take you to the changelogs on the GitHub website. - [0.2.0](https://github.com/hashicorp/consul-ecs/releases/tag/v0.2.0) From 33b5e58aa977158359ba8713161d71b4e9ca4db7 Mon Sep 17 00:00:00 2001 From: Jeff Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Tue, 26 Apr 2022 08:02:12 -0700 Subject: [PATCH 09/12] Update website/content/docs/release-notes/consul/v1_11_x.mdx Co-authored-by: Karl Cardenas --- website/content/docs/release-notes/consul/v1_11_x.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/release-notes/consul/v1_11_x.mdx b/website/content/docs/release-notes/consul/v1_11_x.mdx index d65376cff2..80cac292f6 100644 --- a/website/content/docs/release-notes/consul/v1_11_x.mdx +++ b/website/content/docs/release-notes/consul/v1_11_x.mdx @@ -33,7 +33,7 @@ For more detailed information, please refer to the [upgrade details page](/docs/ The changelogs for this Major release version and any Maintenance versions, are listed below. --> These links will take you to the changelogs on the GitHub website. +-> **Note**: These links will take you to the changelogs on the GitHub website. - [1.11.0](https://github.com/hashicorp/consul/releases/tag/v1.11.0) - [1.11.1](https://github.com/hashicorp/consul/releases/tag/v1.11.1) From 2a1a12fbb94d3520e37f70139b07e01e5e2ee6ac Mon Sep 17 00:00:00 2001 From: Jeff Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Tue, 26 Apr 2022 08:02:22 -0700 Subject: [PATCH 10/12] Update website/content/docs/release-notes/consul/v1_10_x.mdx Co-authored-by: Karl Cardenas --- website/content/docs/release-notes/consul/v1_10_x.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/release-notes/consul/v1_10_x.mdx b/website/content/docs/release-notes/consul/v1_10_x.mdx index c2a627f6be..29ba34cd80 100644 --- a/website/content/docs/release-notes/consul/v1_10_x.mdx +++ b/website/content/docs/release-notes/consul/v1_10_x.mdx @@ -30,7 +30,7 @@ For more detailed information, please refer to the [upgrade details page](/docs/ The changelogs for this Major release version and any Maintenance versions, are listed below. --> These links will take you to the changelogs on the GitHub website. +-> **Note**: These links will take you to the changelogs on the GitHub website. - [1.10.0](https://github.com/hashicorp/consul/releases/tag/v1.10.0) - [1.10.1](https://github.com/hashicorp/consul/releases/tag/v1.10.1) From 3415647c6dfb8a4fda86cf0e5818d4dd634222b3 Mon Sep 17 00:00:00 2001 From: Jeff Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Tue, 26 Apr 2022 08:02:28 -0700 Subject: [PATCH 11/12] Update website/content/docs/release-notes/consul/v1_9_x.mdx Co-authored-by: Karl Cardenas --- website/content/docs/release-notes/consul/v1_9_x.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/release-notes/consul/v1_9_x.mdx b/website/content/docs/release-notes/consul/v1_9_x.mdx index 759125bb05..21ebaa24e4 100644 --- a/website/content/docs/release-notes/consul/v1_9_x.mdx +++ b/website/content/docs/release-notes/consul/v1_9_x.mdx @@ -37,7 +37,7 @@ For more detailed information, please refer to the changelog The changelogs for this Major release version and any Maintenance versions, are listed below. --> These links will take you to the changelogs on the GitHub website. +-> **Note**: These links will take you to the changelogs on the GitHub website. - [1.9.0](https://github.com/hashicorp/consul/releases/tag/v1.9.0) - [1.9.1](https://github.com/hashicorp/consul/releases/tag/v1.9.1) From 720fa3cc89789a2bd02d3822f58c87e7e7eb244e Mon Sep 17 00:00:00 2001 From: Jeff Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Tue, 26 Apr 2022 13:14:10 -0700 Subject: [PATCH 12/12] Apply suggestions from code review Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- .../consul-api-gateway/v0_1_x.mdx | 56 ++++++++++--------- .../docs/release-notes/consul-ecs/v0_2_x.mdx | 4 +- .../docs/release-notes/consul-ecs/v0_4_x.mdx | 4 +- .../docs/release-notes/consul/v1_10_x.mdx | 2 +- .../docs/release-notes/consul/v1_11_x.mdx | 2 +- .../docs/release-notes/consul/v1_9_x.mdx | 4 +- website/content/docs/release-notes/index.mdx | 4 +- 7 files changed, 40 insertions(+), 36 deletions(-) diff --git a/website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx b/website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx index eaea2f6b64..9e4181ba87 100644 --- a/website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx +++ b/website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx @@ -10,60 +10,64 @@ description: >- ## OVerview -This is the first General Availability (GA) release of Consul API Gateway. It -provides controlled access for network traffic, from outside a Consul service -mesh, to Services on the mesh +This is the first general availability (GA) release of Consul API Gateway. It +provides controlled access for network traffic from outside a Consul service +mesh to Services on the mesh -In Kubernetes deployments, it can be used as an alternative to Consul's Ingress -Gateway and provides capabilities Ingress Gateway does not. These include: +You can use API Gateway in Kubernetes deployments as an alternative to Consul's ingress +gateway functionality. It provides additional capabilities that ingress gateway does not. These include: 1. It allows you to configure and deploy new gateways at any time, without rerunning the Consul Helm chart. The configuration of a running gateway can be changed dynamically at anytime, usually without disrupting any the the traffic flowing through it. 1. Listeners on a gateway can use TLS server certificates signed by any - Certificate Authority (CA). This allows you to use certificates from public - CA's, like Verisign and Let's Encrypt, and private CA's, such as a company's + certificate authority (CA). This allows you to use certificates from public + CA's, such as Verisign and Let's Encrypt, and private CA's, such as a company's internal CA. ## Release Highlights +This release includes the following features and capabilities: -1. **Supported Runtimes:** Kubernetes - self managed, AWS EKS, Google GKE and Azure AKS. +1. Can be deployed in the following run time environments: + - Self-managed Kubernetes + - AWS EKS + - Google GKE + - Azure AKS. 1. Install via the HashiCorp Consul Helm chart. 1. Works with self-managed Consul servers and HCP Consul servers 1. Configure via Kubernetes Gateway API - v1alpha2 1. Deploy 1 or more logical API Gateways per Kubernetes cluster -1. Supported protocols: HTTP, HTTPS, TCP, TCP+TLS -1. Supported HTTP versions: 1.1 & 2 +1. Support for HTTP, HTTPS, TCP, and TCP+TLS +1. Support for HTTP versions 1.1 and 2 1. Load balance across a service’s instances -1. Listeners load TLS certificates, signed by any CA, from Kubernetes Secret Storage +1. Listeners load TLS certificates, signed by any CA, from Kubernetes secret storage 1. Route HTTP/S traffic to Services based on matching: - Hostname - URI Path - HTTP Header - HTTP Method - HTTP Query parameters -1 HTTP Header manipulation: +1 HTTP header manipulation: - Set header value - Add header and/or value - Remove header and/or value -1. TLS settings configurable per Listener: +1. TLS settings configurable per Kubernetes Listener: - Set minimum allowed TLS version - - Enabled cipher-suites (a.k.a. Cipher string) -1. Route to services in different Name Spaces -1. Split traffic across multiple services, based on weight -1. Support multi-runtime service mesh deployments - - The Consul API Gateway must be running on Kubernetes but it can route - traffic to services running outside of K8s as long the service is connected - to the Consul service mesh. + - Enabled cipher-suites (a.k.a. cipher string) +1. Route to services in different namespaces +1. Split traffic across multiple services based on weight +1. Support for multi-runtime service mesh deployments + - Consul API Gateway must be running on Kubernetes, but it can route + traffic to services running outside of K8s as long the service is connected to the Consul service mesh. -## Supported Software - Minimum Versions +## Supported Software -- Consul: 1.11.2+ -- HashiCorp Consul Helm chart: 0.41.1+ -- Kubernetes: 1.21+ -- Kubectl: 1.21+ -- Envoy Proxy: Determined by the Consul version deployed +- Consul 1.11.2+ +- HashiCorp Consul Helm chart 0.41.1+ +- Kubernetes 1.21+ +- Kubectl 1.21+ +- Envoy proxy support is determined by the Consul version deployed. Refer to [Envoy Integration](/docs/connect/proxies/envoy) for details. ## Kubernetes Gateway API Specification diff --git a/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx index 0700504334..1aa3d32367 100644 --- a/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx +++ b/website/content/docs/release-notes/consul-ecs/v0_2_x.mdx @@ -15,11 +15,11 @@ description: >- ## Support Software Versions -- Consul: 1.10.x +- Consul 1.10.x ## Changelogs -The changelogs for this Major release version and any Maintenance versions, are listed below. +The changelogs for this major release version and any maintenance versions are listed below. -> **Note**: These links will take you to the changelogs on the GitHub website. diff --git a/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx b/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx index cdb2d85f71..18e6028a94 100644 --- a/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx +++ b/website/content/docs/release-notes/consul-ecs/v0_4_x.mdx @@ -13,13 +13,13 @@ description: >- - **Namespaces (Enterprise) :** This feature enables autonomy across teams by allowing creation of isolated environments in shared clusters. -## Support Software Versions +## Supported Software Versions - Consul: 1.10.x, 1.11.x, 1.12.x ## Changelogs -The changelogs for this Major release version and any Maintenance versions, are listed below. +The changelogs for this major release version and any maintenance versions are listed below. -> **Note**: These links will take you to the changelogs on the GitHub website. diff --git a/website/content/docs/release-notes/consul/v1_10_x.mdx b/website/content/docs/release-notes/consul/v1_10_x.mdx index 29ba34cd80..e4531dec08 100644 --- a/website/content/docs/release-notes/consul/v1_10_x.mdx +++ b/website/content/docs/release-notes/consul/v1_10_x.mdx @@ -28,7 +28,7 @@ For more detailed information, please refer to the [upgrade details page](/docs/ ## Changelogs -The changelogs for this Major release version and any Maintenance versions, are listed below. +The changelogs for this major release version and any maintenance versions are listed below. -> **Note**: These links will take you to the changelogs on the GitHub website. diff --git a/website/content/docs/release-notes/consul/v1_11_x.mdx b/website/content/docs/release-notes/consul/v1_11_x.mdx index 80cac292f6..6b764f9774 100644 --- a/website/content/docs/release-notes/consul/v1_11_x.mdx +++ b/website/content/docs/release-notes/consul/v1_11_x.mdx @@ -31,7 +31,7 @@ For more detailed information, please refer to the [upgrade details page](/docs/ ## Changelogs -The changelogs for this Major release version and any Maintenance versions, are listed below. +The changelogs for this major release version and any maintenance versions are listed below. -> **Note**: These links will take you to the changelogs on the GitHub website. diff --git a/website/content/docs/release-notes/consul/v1_9_x.mdx b/website/content/docs/release-notes/consul/v1_9_x.mdx index 21ebaa24e4..8f095726d8 100644 --- a/website/content/docs/release-notes/consul/v1_9_x.mdx +++ b/website/content/docs/release-notes/consul/v1_9_x.mdx @@ -31,11 +31,11 @@ description: >- - Drops support for Envoy versions 1.12.0, 1.12.1, 1.12.2, and 1.13.0 - Switches the default gateway port from 443 to 8443 to avoid assumption of Envoy running as root. -For more detailed information, please refer to the changelog +Refer to the changelog for additional information. ## Changelogs -The changelogs for this Major release version and any Maintenance versions, are listed below. +The changelogs for this major release version and any maintenance versions are listed below. -> **Note**: These links will take you to the changelogs on the GitHub website. diff --git a/website/content/docs/release-notes/index.mdx b/website/content/docs/release-notes/index.mdx index 74a56fd491..4b31ad9196 100644 --- a/website/content/docs/release-notes/index.mdx +++ b/website/content/docs/release-notes/index.mdx @@ -7,6 +7,6 @@ description: |- # Release Notes -Use the navigation panel, to the left, to see the Release Notes for each of the major software packages in the Consul product line +Choose a version from the navigation sidebar to view the release notes for each of the major software packages in the Consul product line. -Documentation for maintenance releases (e.g., 0.1.x) is added to the bottom of each Release Notes page. +Documentation for maintenance releases (e.g., 0.1.x) is on the bottom of each release notes page.