Merge pull request #12858 from hashicorp/japple-rel-notes-reorg

Reorganization of the Release Notes on Consul.io
pull/12860/head
Jeff Apple 2022-04-26 13:29:26 -07:00 committed by GitHub
commit 390586fa99
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 312 additions and 81 deletions

View File

@ -49,10 +49,9 @@ Consul API Gateway can be deployed in the following Kubernetes-based environment
- Google Kubernetes Engine (GKE) - Google Kubernetes Engine (GKE)
- Azure Kubernetes Service (AKS) - Azure Kubernetes Service (AKS)
## Kubernetes Gateway API Specification ## Kubernetes Gateway API Specification - Supported Versions
Supported version of the Gateway API spec: v1alpha2
See the Release Notes for the version of Consul API Gateway being used.
## Resource Allocations ## Resource Allocations
@ -60,10 +59,10 @@ The following resources are allocated for each component of the API Gateway.
### Gateway Controller Pod ### Gateway Controller Pod
* **CPU**: None. Either 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. - **Memory**: None. Either the the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration.
### Gateway Instance Pod ### Gateway Instance Pod
* **CPU**: None. Either 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 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.

View File

@ -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).

View File

@ -0,0 +1,76 @@
---
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
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, 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. 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. Support for HTTP, HTTPS, TCP, and TCP+TLS
1. Support for HTTP versions 1.1 and 2
1. Load balance across a services 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 Kubernetes Listener:
- Set minimum allowed TLS version
- 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
- 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
Supported version of the Gateway API spec: `v1alpha2`(v0.4.1)
For more detailed information, please refer to the [product documentation](/docs/api-gateway).

View File

@ -0,0 +1,26 @@
---
layout: docs
page_title: 0.2.x
description: >-
Consul ECS release notes for version 0.2.x
---
# Consul ECS 0.2.0
## Release Highlights
- **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.
- **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 1.10.x
## Changelogs
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.
- [0.2.0](https://github.com/hashicorp/consul-ecs/releases/tag/v0.2.0)

View File

@ -0,0 +1,24 @@
---
layout: docs
page_title: 0.3.x
description: >-
Consul ECS release notes for version 0.3.x
---
# Consul ECS 0.3.0
## Release Highlights
- **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: 1.10.x, 1.11.x
## Changelogs
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.
- [0.3.0](https://github.com/hashicorp/consul-ecs/releases/tag/v0.3.0)

View File

@ -0,0 +1,28 @@
---
layout: docs
page_title: 0.4.x
description: >-
Consul ECS release notes for version 0.4.x
---
# Consul ECS 0.4.0
## Release Highlights
- **Admin Partitions (Enterprise) :** This feature supports various deployment patterns that enable multiple ECS clusters from different tenants to share a single Consul control plane.
- **Namespaces (Enterprise) :** This feature enables autonomy across teams by allowing creation of isolated environments in shared clusters.
## 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.
-> **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)
- [0.4.1](https://github.com/hashicorp/consul-ecs/releases/tag/v0.4.1)

View File

@ -1,8 +1,8 @@
--- ---
layout: docs layout: docs
page_title: CTS v0.5.0 page_title: CTS v0.5.x
description: >- 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 -> The release notes for v0.5.0 focus on a subset of configuration deprecations

View File

@ -1,6 +1,8 @@
--- ---
layout: docs 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 # Consul 1.10.0
@ -22,4 +24,22 @@ page_title: 1.10.0
- Drops support for Envoy version 1.13.x. - 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. - (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.
-> **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)
- [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)

View File

@ -1,6 +1,8 @@
--- ---
layout: docs 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 # Consul 1.11.0
@ -25,4 +27,17 @@ page_title: 1.11.0
- Drops support for Envoy versions 1.15.x and 1.16.x - 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.
-> **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)
- [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)

View File

@ -1,6 +1,8 @@
--- ---
layout: docs 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 # Consul 1.9.0
@ -29,4 +31,29 @@ page_title: 1.9.0
- Drops support for Envoy versions 1.12.0, 1.12.1, 1.12.2, and 1.13.0 - 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. - 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). Refer to the changelog for additional information.
## Changelogs
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.
- [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)

View File

@ -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
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 on the bottom of each release notes page.

View File

@ -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/).

View File

@ -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).

View File

@ -850,19 +850,6 @@
{ {
"title": "Compatibility", "title": "Compatibility",
"path": "nia/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"
}
]
} }
] ]
}, },
@ -1201,31 +1188,62 @@
} }
] ]
}, },
{
"title": "Releases",
"routes": [
{
"title": "Overview",
"path": "releases"
},
{ {
"title": "Release Notes", "title": "Release Notes",
"routes": [ "routes": [
{ {
"title": "Overview", "title": "Overview",
"path": "releases/release-notes" "path": "release-notes"
}, },
{ {
"title": "v1.11.0", "title": "Consul",
"path": "releases/release-notes/v1_11_0" "routes": [
{
"title": "v1.11.x",
"path": "release-notes/consul/v1_11_x"
}, },
{ {
"title": "v1.10.0", "title": "v1.10.x",
"path": "releases/release-notes/v1_10_0" "path": "release-notes/consul/v1_10_x"
}, },
{ {
"title": "v1.9.0", "title": "v1.9.x",
"path": "releases/release-notes/v1_9_0" "path": "release-notes/consul/v1_9_x"
}
]
},
{
"title": "Consul API Gateway",
"routes": [
{
"title": "v0.1.x",
"path": "release-notes/consul-api-gateway/v0_1_x"
}
]
},
{
"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 Terraform Sync",
"routes": [
{
"title": "v0.5.x",
"path": "release-notes/consul-terraform-sync/v0_5_x"
} }
] ]
} }

View File

@ -1246,17 +1246,17 @@ module.exports = [
}, },
{ {
source: '/docs/release-notes/1-11-0', 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, permanent: true,
}, },
{ {
source: '/docs/release-notes/1-10-0', 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, permanent: true,
}, },
{ {
source: '/docs/release-notes/1-9-0', 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, permanent: true,
}, },
{ {
@ -1269,6 +1269,26 @@ module.exports = [
destination: '/docs/agent/config/config-files', destination: '/docs/agent/config/config-files',
permanent: true, 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/0-5-0',
destination: '/docs/release-notes/consul-terraform-sync/v0_5_x',
permanent: true,
},
{ {
source: '/docs/api-gateway/api-gateway-usage', source: '/docs/api-gateway/api-gateway-usage',
destination: '/docs/api-gateway/consul-api-gateway-install', destination: '/docs/api-gateway/consul-api-gateway-install',