Docs: Release Notes reorg - adding ECS and NIA

This commit is contained in:
Jeff-Apple 2022-04-25 20:59:18 -07:00
parent 154b2fb033
commit a37615318d
13 changed files with 170 additions and 213 deletions

View File

@ -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 <br/> 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.
- **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.

View File

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

View File

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

View File

@ -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
<!--
Instructions for the upgrading process can go here. If standard upgrade instructions
already exist in the product docs, this section can just cover anything unique about
upgrading to this version and a link to the page where the standard instructions are.
An example is included bellow.
-->
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)

View File

@ -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
<!--
Instructions for the upgrading process can go here. If standard upgrade instructions
already exist in the product docs, this section can just cover anything unique about
upgrading to this version and a link to the page where the standard instructions are.
An example is included bellow.
-->
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)

View File

@ -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
<!--
Instructions for the upgrading process can go here. If standard upgrade instructions
already exist in the product docs, this section can just cover anything unique about
upgrading to this version and a link to the page where the standard instructions are.
An example is included bellow.
-->
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)

View File

@ -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
<!--
Instructions for the upgrading process can go here. If standard upgrade instructions
already exist in the product docs, this section can just cover anything unique about
upgrading to this version and a link to the page where the standard instructions are.
An example is included bellow.
-->
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).

View File

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

View File

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

View File

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

View File

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

View File

@ -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": [

View File

@ -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,
},
]