From e9c983f36107b044fcd889f738b3d5ba2b922e7a Mon Sep 17 00:00:00 2001 From: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Date: Wed, 12 Jun 2024 14:44:35 -0700 Subject: [PATCH] docs: consul-k8s v1.5.0 release notes (#21320) * consul-k8s 1.5.0 release notes * Nav Entry * Envoy version bumps * Version updates/corrections * external crd description update --- .../content/docs/connect/proxies/envoy.mdx | 2 + .../docs/release-notes/consul-k8s/v1_5_x.mdx | 46 +++++++++++++++++++ .../docs/release-notes/consul/v1_19_x.mdx | 4 +- website/data/docs-nav-data.json | 4 ++ 4 files changed, 54 insertions(+), 2 deletions(-) create mode 100644 website/content/docs/release-notes/consul-k8s/v1_5_x.mdx diff --git a/website/content/docs/connect/proxies/envoy.mdx b/website/content/docs/connect/proxies/envoy.mdx index 79eab9e57637..0962ccbb290c 100644 --- a/website/content/docs/connect/proxies/envoy.mdx +++ b/website/content/docs/connect/proxies/envoy.mdx @@ -119,6 +119,7 @@ until the LTS release reaches its end of maintenance. | Consul Version | Default `consul-dataplane` Version | Other compatible `consul-dataplane` Versions | | -------------- | -------------------------------------|----------------------------------------------| +| 1.19.x Ent | 1.5.x (Envoy 1.29.x) | 1.4.x (Envoy 1.28.x) | | 1.18.x Ent | 1.4.x (Envoy 1.28.x) | 1.3.x (Envoy 1.27.x) | | 1.15.x Ent | 1.1.x (Envoy 1.26.x) | 1.4.x (Envoy 1.28.x) - 1.0.x (Envoy 1.24.x) | @@ -131,6 +132,7 @@ of Consul dataplane use a maintained version of Envoy. | `consul-dataplane` Version Range | Associated Consul Enterprise LTS version | Contained Envoy Binary Version | | -------------------------------- | ---------------------------------------- | ------------------------------ | +| 1.5.0 - 1.5.latest | 1.18.x Ent | Envoy 1.29.x | | 1.4.0 - 1.4.latest | 1.18.x Ent | Envoy 1.28.x | | 1.1.9 - 1.1.latest | 1.15.x Ent | Envoy 1.26.x | | 1.1.0 - 1.1.8 | 1.15.x Ent | Envoy 1.25.x | diff --git a/website/content/docs/release-notes/consul-k8s/v1_5_x.mdx b/website/content/docs/release-notes/consul-k8s/v1_5_x.mdx new file mode 100644 index 000000000000..d46bc0bb2fe6 --- /dev/null +++ b/website/content/docs/release-notes/consul-k8s/v1_5_x.mdx @@ -0,0 +1,46 @@ +--- +layout: docs +page_title: 1.5.x +description: >- + Consul on Kubernetes release notes for version 1.5.x +--- + +# Consul on Kubernetes 1.5.0 + +We are pleased to announce the following Consul updates. + +## Release highlights + +- **External Services CRD**: You can now configure and register external services, including their health checks, alongside existing Kubernetes application manifests with the new [`Registration` Custom Resource Definition (CRD)](/consul/docs/connect/config-entries/registration). The CRD removes the requirement to deploy a terminating gateway in order to register a service running on an external node in Consul on Kubernetes, but a terminating gateway is still required to make the external service available to downstream services in the service mesh. Refer to [Register external services on Kubernetes overview](/consul/docs/k8s/deployment-configurations/external-service) for more information. + +- **File system certificate**: A new [`file-system-certificate` configuration entry](/consul/docs/connect/config-entries/file-system-certificate) for Consul API Gateway on VMs supports specifying a filepath to the certificate and private key on the local system. Consul on Kubernetes deployments that use `consul-k8s` Helm chart v1.5.0 or later use file system certificates instead of inline certificates without additional configuration. For information about certificate configuration for Kubernetes environments, refer to [Gateway Resource Configuration](/consul/docs/connect/gateways/api-gateway/configuration/gateway). + +- **v2 catalog API deprecation**: Consul introduced an experimental v2 Catalog API in v1.17.0. This API supported multi-port Service configurations on Kubernetes, and it was made available for testing and development purposes. The v2 catalog and its support for multiport Kubernetes Services were deprecated in the v1.19.0 release. + +## Supported software + +This version of Consul on Kubernetes supports the following software versions: + +- Consul v1.19.x +- Consul Dataplane v1.5.x. Refer to [Envoy and Consul Dataplane](/consul/docs/v1.19.x/connect/proxies/envoy#envoy-and-consul-dataplane) for details about Consul Dataplane versions and the available packaged Envoy version. +- Kubernetes 1.27.x - 1.30.x +- kubectl 1.27.x - 1.30.x +- Helm 3.11.3+ + +Refer to [Supported Consul and Kubernetes versions](/consul/docs/v1.19.x/k8s/compatibility#supported-consul-and-kubernetes-versions) for more information. + +## Upgrading + +For more detailed information, please refer to the [upgrade details page](/consul/docs/upgrading/upgrade-specific) and the changelogs. + +## Known issues + +The following issues are known to exist in the v1.5.x releases: + +## Changelogs + +The changelogs for this major release version and any maintenance versions are listed below. + + These links take you to the changelogs on the GitHub website. + +- [1.5.0](https://github.com/hashicorp/consul-k8s/releases/tag/v1.5.0) diff --git a/website/content/docs/release-notes/consul/v1_19_x.mdx b/website/content/docs/release-notes/consul/v1_19_x.mdx index bb724aa29027..5423ce0dba72 100644 --- a/website/content/docs/release-notes/consul/v1_19_x.mdx +++ b/website/content/docs/release-notes/consul/v1_19_x.mdx @@ -11,7 +11,7 @@ We are pleased to announce the following Consul updates. ## Release highlights -- **External Services CRD**: You can now configure and register external services, including their health checks, alongside existing Kubernetes application manifests with the new [`Registration` Custom Resource Definition (CRD)](/consul/docs/connect/config-entries/registration). The CRD removes the requirement to deploy a terminating gateway in order to register a service running on an external node in Consul on Kubernetes. Refer to [Register external services on Kubernetes overview](/consul/docs/k8s/deployment-configurations/external-service) for more information. +- **External Services CRD**: You can now configure and register external services, including their health checks, alongside existing Kubernetes application manifests with the new [`Registration` Custom Resource Definition (CRD)](/consul/docs/connect/config-entries/registration). The CRD removes the requirement to deploy a terminating gateway in order to register a service running on an external node in Consul on Kubernetes, but a terminating gateway is still required to make the external service available to downstream services in the service mesh. Refer to [Register external services on Kubernetes overview](/consul/docs/k8s/deployment-configurations/external-service) for more information. - **Transparent Proxy on Nomad**: Consul’s CNI plugin enables the use of transparent proxy for seamlessly redirecting traffic through the Envoy proxy without requiring application changes, or elevated network privileges for the workload. As a result, you can onboard applications without additional configuration between a service and its upstreams. @@ -19,7 +19,7 @@ We are pleased to announce the following Consul updates. - **File system certificate configuration entry**: A new [`file-system-certificate` configuration entry](/consul/docs/connect/config-entries/file-system-certificate) supports specifying a filepath to the certificate and private key for Consul API Gateway on VMs on the local system. Previously, the certificate and private key were specified directly in the `inline-certificate` configuration entry. When using the file system certificates, the Consul server never sees the contents of these files. - File system certificates also include a file system watch that implements certificate and key changes without restarting the gateway. They also require that you have access to the gateway's file system in order to place the certificate or update it. + File system certificates also include a file system watch that allows for changing the certificate and key without restarting the gateway. This feature requires that you have access to the gateway’s file system in order to place the certificate or update it. Consul on Kubernetes deployments that use `consul-k8s` Helm chart v1.5.0 or later use file system certificates without additional configuration. For more information, refer to [File system certificate configuration reference](/consul/docs/connect/config-entries/file-system-certificate). diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index d5bc1ad83e70..6f44bfd9830a 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -202,6 +202,10 @@ { "title": "Consul K8s", "routes": [ + { + "title": "v1.5.x", + "path": "release-notes/consul-k8s/v1_5_x" + }, { "title": "v1.4.x", "path": "release-notes/consul-k8s/v1_4_x"