Apply suggestions from code review

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
This commit is contained in:
Jeff Apple 2022-04-26 13:14:10 -07:00 committed by GitHub
parent 3415647c6d
commit 720fa3cc89
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 40 additions and 36 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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