Added Known Issues and other edits to Rel Notes

This commit is contained in:
Jeff-Apple 2022-08-16 10:48:13 -07:00
parent 3dcd60f805
commit 32dfb1615d

View File

@ -25,12 +25,15 @@ description: >-
API. Once an API reaches `v1beta1` status, future versions must comply with API. Once an API reaches `v1beta1` status, future versions must comply with
several backward compatibility requirements. several backward compatibility requirements.
- **URL Path Prefix Rewrite** - **URL Path Prefix Rewrite** This release introduces support for rewriting a
This release introduces support for rewriting a URL's path prefix when routing URL's path prefix when routing HTTP traffic. To use this functionality, add a
HTTP traffic. To use this functionality, add a `URLRewrite` filter to an `URLRewrite` filter to an `HTTPRoute` configuration. This enables the gateway
`HTTPRoute` configuration. This enables the gateway to rewrite the URL path in a client's HTTP request before sending the request to a service. For example, you could configure the gateway to change the path from `//store/checkout` to `//cart/checkout`. Refer to the [usage documentation](/docs/api-gateway/usage) for additional information. to rewrite the URL path in a client's HTTP request before sending the request
to a service. For example, you could configure the gateway to change the path
from `//store/checkout` to `//cart/checkout`. Refer to the [usage
documentation](/docs/api-gateway/usage) for additional information.
## What Has Changed ## What has Changed
- **Reference Policy Renamed to Reference Grant** In v0.5.0 of the Kubernetes - **Reference Policy Renamed to Reference Grant** In v0.5.0 of the Kubernetes
Gateway API, `ReferencePolicy` has been renamed to `ReferenceGrant`. This Gateway API, `ReferencePolicy` has been renamed to `ReferenceGrant`. This
@ -38,13 +41,13 @@ description: >-
in a future version of the standard. in a future version of the standard.
After upgrading to this version of Consul API Gateway, you should rename all After upgrading to this version of Consul API Gateway, you should rename all
existing `ReferencePolicy`y to `ReferenceGrant`s. Refer to the [Upgrades](/docs/api-gateway/upgrades) existing `ReferencePolicy` to `ReferenceGrant`. Refer to the [Upgrades](/docs/api-gateway/upgrades)
instructions for additional details. instructions for additional details.
## Supported Software ## Supported Software
- Consul 1.11.2+ - Consul 1.11.2+
- HashiCorp Consul Helm chart 0.47.0+ - HashiCorp Consul Helm chart 0.47.1+
- Kubernetes 1.21+ - Kubernetes 1.21+
- Kubernetes 1.24 is not supported at this time. - Kubernetes 1.24 is not supported at this time.
- Kubectl 1.21+ - Kubectl 1.21+
@ -59,6 +62,14 @@ Supported version of the [Gateway API](https://gateway-api.sigs.k8s.io/) spec: v
For detailed information on upgrading, please refer to the [Upgrades page](/docs/api-gateway/upgrades) For detailed information on upgrading, please refer to the [Upgrades page](/docs/api-gateway/upgrades)
## Known Issues
The following issues are know to exist in the v0.4.0 release
- API Gateway pods fail to start if namespace mirroring enabled and destination
namespace doesn't exist. See GitHub Issue
[#248](https://github.com/hashicorp/consul-api-gateway/issues/248) for
details.
## Changelogs ## 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.