diff --git a/CHANGELOG.md b/CHANGELOG.md index ebb73780da..56927abd44 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,28 @@ This document includes a curated changelog for each release. We also publish a c a [GitHub release](https://github.com/nginxinc/nginx-kubernetes-gateway/releases), which, by contrast, is auto-generated and includes links to all PRs that went into the release. +## Release 0.6.0 + +*August 31, 2023* + +This release adds a Helm chart, dynamic control plane logging, Prometheus metrics, and in-depth guides for various use cases. + +FEATURES: + +- Helm chart. [PR-840](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/840) +- Use custom nginx container. [PR-934](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/934) +- Support dynamic control plane logging. [PR-943](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/943) +- Support websocket connections. [PR-962](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/962) +- Support Prometheus metrics. [PR-999](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/999) + +BUG FIXES: + +- Ensure NGINX Kubernetes Gateway has least privileges. [PR-1004](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/1004) + +DOCUMENTATION: + +- Use case guides: https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/docs/guides + ## Release 0.5.0 *July 17, 2023* diff --git a/README.md b/README.md index 1acf4420b9..9ea05d074e 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Learn about our [design principles](/docs/developer/design-principles.md) and [a We publish NGINX Kubernetes Gateway releases on GitHub. See our [releases page](https://github.com/nginxinc/nginx-kubernetes-gateway/releases). -The latest release is [0.5.0](https://github.com/nginxinc/nginx-kubernetes-gateway/releases/tag/v0.5.0). +The latest release is [0.6.0](https://github.com/nginxinc/nginx-kubernetes-gateway/releases/tag/v0.6.0). The edge version is useful for experimenting with new features that are not yet published in a release. To use, choose the *edge* version built from the [latest commit](https://github.com/nginxinc/nginx-kubernetes-gateway/commits/main) @@ -51,7 +51,7 @@ to the correct versions: | Version | Description | Image | Installation Manifests | Documentation and Examples | |----------------|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Latest release | For experimental use | Use the 0.5.0 image from [GitHub](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) | [Manifests](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.5.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.5.0/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.5.0/examples). | +| Latest release | For experimental use | Use the 0.6.0 image from [GitHub](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) | [Manifests](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/examples). | | Edge | For experimental use and latest features | Use the edge image from [GitHub](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) | [Manifests](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/examples). | ## Technical Specifications @@ -60,7 +60,8 @@ The following table lists the software versions NGINX Kubernetes Gateway support | NGINX Kubernetes Gateway | Gateway API | Kubernetes | NGINX OSS | |--------------------------|-------------|------------|-----------| -| Edge | 0.8.0 | 1.22+ | 1.25.2 | +| Edge | 0.8.0 | 1.23+ | 1.25.2 | +| 0.6.0 | 0.8.0 | 1.23+ | 1.25.2 | | 0.5.0 | 0.7.1 | 1.21+ | 1.25.x * | | 0.4.0 | 0.7.1 | 1.21+ | 1.25.x * | | 0.3.0 | 0.6.2 | 1.21+ | 1.23.x * | diff --git a/docs/release-process.md b/docs/release-process.md index 2792e45f11..35fa681de8 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -35,11 +35,11 @@ To create a new release, follow these steps: 1. Update the Helm [Chart.yaml](../deploy/helm-chart/Chart.yaml): the `appVersion` to `X.Y.Z`, the icon and source URLs to point at `vX.Y.Z`, and bump the `version`. 2. Update the Helm [README](../deploy/helm-chart/README.md) `--version` flags in the helm commands to use the stable - `appVersion` from the previous step. + `version` from the previous step. 3. Adjust the `VERSION` variable in the [Makefile](../Makefile) and the `NKG_TAG` in the [conformance tests Makefile](../conformance/Makefile) to `X.Y.Z`. 4. Update the tag of NKG container images used in the Helm [values.yaml](../deploy/helm-chart/values.yaml) file, the - [provisioner manifest](../conformance/provisioner/provisioner.yaml)), and all docs to `X.Y.Z`. + [provisioner manifest](../conformance/provisioner/provisioner.yaml), and all docs to `X.Y.Z`. 5. Ensure that the `imagePullPolicy` is `IfNotPresent` in the Helm [values.yaml](../deploy/helm-chart/values.yaml) file. 6. Generate the installation manifests by running `make generate-manifests`. @@ -59,6 +59,12 @@ To create a new release, follow these steps: 8. Prepare and merge a PR into the main branch to update the [README](../README.md) to include the information about the latest release and also the [changelog](../CHANGELOG.md). 9. Close the issue created in Step 1. +10. Submit the `conformance-profile.yaml` artifact from the release to the [Gateway API repo](https://github.com/kubernetes-sigs/gateway-api/tree/main/conformance/reports). + - Create a fork of the repository + - Name the file `nginxinc-nginx-kubernetes-gateway.yaml` and set `gatewayAPIVersion` in the file to the + supported version by NKG. Also update the site source if necessary (see following example). + - Open a PR. [Example](https://github.com/kubernetes-sigs/gateway-api/pull/2368) + If it's your first time submitting a PR, you will need to sign a CLA using F5, Inc. as the organization. ### Patch Release