From 0b80402ebb0ed2163035f4c3649900f39ee8fed5 Mon Sep 17 00:00:00 2001 From: Jeff-Apple <79924108+Jeff-Apple@users.noreply.github.com> Date: Mon, 20 Jun 2022 17:00:11 -0700 Subject: [PATCH] API GW 0.3 Release Notes and updated Tech Specs --- .../content/docs/api-gateway/tech-specs.mdx | 5 +- .../consul-api-gateway/v0_2_x.mdx | 6 +- .../consul-api-gateway/v0_3_x.mdx | 59 +++++++++++++++++++ website/data/docs-nav-data.json | 8 ++- 4 files changed, 71 insertions(+), 7 deletions(-) create mode 100644 website/content/docs/release-notes/consul-api-gateway/v0_3_x.mdx diff --git a/website/content/docs/api-gateway/tech-specs.mdx b/website/content/docs/api-gateway/tech-specs.mdx index bfd9e893c4..e499349198 100644 --- a/website/content/docs/api-gateway/tech-specs.mdx +++ b/website/content/docs/api-gateway/tech-specs.mdx @@ -18,9 +18,10 @@ Verify that your environment meets the following requirements prior to using Con Your datacenter must meet the following requirements prior to configuring the Consul API Gateway: - Kubernetes 1.21+ + - Kubernetes 1.24 is not supported at this time. - `kubectl` 1.21+ -- Consul 1.12.0+ -- HashiCorp Consul Helm chart 0.43.0+ +- Consul 1.11.2+ +- HashiCorp Consul Helm chart 0.45.0+ - Consul Service Mesh must be deployed on the Kubernetes cluster that API Gateway is deployed on. - Envoy: Envoy proxy support is determined by the Consul version deployed. Refer to [Envoy Integration](/docs/connect/proxies/envoy) for details. diff --git a/website/content/docs/release-notes/consul-api-gateway/v0_2_x.mdx b/website/content/docs/release-notes/consul-api-gateway/v0_2_x.mdx index cb5370b3f0..3643b72628 100644 --- a/website/content/docs/release-notes/consul-api-gateway/v0_2_x.mdx +++ b/website/content/docs/release-notes/consul-api-gateway/v0_2_x.mdx @@ -18,9 +18,9 @@ description: >- was reachable, it didn’t allow users to set the more granular restrictions or permissions that they may expect. - This version of API Gateway implements Cross Namespace Reference Policies - and requires them when routes are in a different namespace than the services - (as specified by the `backendRef`) they are routing traffic to. + This version of API Gateway implements Cross Namespace Reference Policies + and requires them when routes are in a different namespace than the services + (as specified by the `backendRef`) they are routing traffic to. ## Supported Software diff --git a/website/content/docs/release-notes/consul-api-gateway/v0_3_x.mdx b/website/content/docs/release-notes/consul-api-gateway/v0_3_x.mdx new file mode 100644 index 0000000000..1d177d0081 --- /dev/null +++ b/website/content/docs/release-notes/consul-api-gateway/v0_3_x.mdx @@ -0,0 +1,59 @@ +--- +layout: docs +page_title: 0.3.x +description: >- + Consul API Gateway release notes for version 0.3.x +--- + +# Consul API Gateway 0.3.0 + +## Release Highlights + +- **Improved High Availability and Scalability via Multiple Instances per Gateway:** + This release introduces support for deploying multiple instances of a logical + gateway (i.e. a K8s `gateway` config object). You can use a external load + balancing service to distribute incoming traffic across the instances of a + gateway. This provides higher availability of gateway services and also allows + a single logical gateway to handle a volume of network traffic that is much + greater than what a single instance of a gateway can. + + Administrators can set the number of instances independently for each logical + gateway. Administrators can also set, in the `gatewayClassConfig`, the + minimum, maximum and default number of gateway instances. These are applied + per `gateway` to all `gateways` in that `gatewayClass`. The minimum and + maximum settings will override settings configured on any given `gateway`. + + Note: There is a hard limit of eight (8) instances per `gateway` and it can + not be overridden. This hard limit will probably be increased in the future. + +- **Cross Namespace Reference Policies for Certificates:** + Reference policies is a security feature introduced in the 0.2 release. In + this release, Reference Policies are now required for TLS certificates when a + `listener` has a `certificateRef` that is in a different `namespace`. + + +## Supported Software + +- Consul 1.11.2+ +- HashiCorp Consul Helm chart 0.45.0+ +- Kubernetes 1.21+ + - Kubernetes 1.24 is not supported at this time. +- 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) + +## Upgrading + +For detailed information on upgrading, please refer to the [upgrade details page](/docs/api-gateway/upgrade-specific-versions) + +## Change logs + +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-api-gateway/releases/tag/v0.3.0) diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index f009f56112..3785b41823 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -1232,12 +1232,16 @@ "title": "Consul API Gateway", "routes": [ { - "title": "v0.1.x", - "path": "release-notes/consul-api-gateway/v0_1_x" + "title": "v0.3.x", + "path": "release-notes/consul-api-gateway/v0_3_x" }, { "title": "v0.2.x", "path": "release-notes/consul-api-gateway/v0_2_x" + }, + { + "title": "v0.1.x", + "path": "release-notes/consul-api-gateway/v0_1_x" } ] },