diff --git a/CHANGELOG.md b/CHANGELOG.md index dd8485a7fe..24d147134d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,53 @@ This document includes a curated changelog for each release. We also publish a c a [GitHub release](https://github.com/nginxinc/nginx-gateway-fabric/releases), which, by contrast, is auto-generated and includes links to all PRs that went into the release. +## Release 1.1.0 + +*December 14, 2023* + +This release updates NGINX Gateway Fabric to support version 1.0.0 of the Gateway API in addition to bug fixes and documentation updates. Our docs are now available at https://docs.nginx.com/nginx-gateway-fabric. + +FEATURES: + +- Update to v1.0.0 of the Gateway API. [PR-1250](https://github.com/nginxinc/nginx-gateway-fabric/pull/1250) +- Set the SupportedVersion Condition on GatewayClass. [PR-1301](https://github.com/nginxinc/nginx-gateway-fabric/pull/1301) + +BUG FIXES: + +- Merge HTTPRoute conditions from all Gateway controllers. [PR-1220](https://github.com/nginxinc/nginx-gateway-fabric/pull/1220) +- Validate header names and report validation errors in the HTTPRoute status. [PR-1239](https://github.com/nginxinc/nginx-gateway-fabric/pull/1239) +- Remove usage info from log output. [PR-1242](https://github.com/nginxinc/nginx-gateway-fabric/pull/1242) +- Set the Gateway Listener status AttachedRoutes field to the number of Routes associated with a Listener regardless of Gateway or Route status. [PR-1275](https://github.com/nginxinc/nginx-gateway-fabric/pull/1275) +- Set file mode explicitly for regular NGINX configuration files. [PR-1323](https://github.com/nginxinc/nginx-gateway-fabric/pull/1323). Thanks to [Kai-Hsun Chen](https://github.com/kevin85421). + +DOCUMENTATION: + +- Documentation is now available on docs.nginx.com. [Link](https://docs.nginx.com/nginx-gateway-fabric/) +- Update the resource validation documents to cover CEL validation. [Link](https://docs.nginx.com/nginx-gateway-fabric/overview/resource-validation/) +- Non-functional testing results. [Link](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/tests) + +HELM CHART: + +- The version of the Helm chart is now 1.1.0. +- Add tolerations to the helm chart. [PR-1192](https://github.com/nginxinc/nginx-gateway-fabric/pull/1192). Thanks to [Jerome Brown](https://github.com/oWretch). +- Add extra volume mounts to the helm chart. [PR-1193](https://github.com/nginxinc/nginx-gateway-fabric/pull/1193). Thanks to [Jerome Brown](https://github.com/oWretch). +- Fix broken helm chart icon links. [PR-1290](https://github.com/nginxinc/nginx-gateway-fabric/pull/1290). Thanks to [arukiidou](https://github.com/arukiidou). + +UPGRADE: + +- This version of NGINX Gateway Fabric is not compatible with v0.8.0 of the Gateway API. You must upgrade the Gateway API CRDs to v1.0.0 before upgrading NGINX Gateway Fabric. For instructions, see the upgrade documentation for [helm](https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/helm/#upgrade-nginx-gateway-fabric) or [manifests](https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/manifests/#upgrade-nginx-gateway-fabric). + +COMPATIBILITY: + +- The Gateway API version: `1.0.0` +- NGINX version: `1.25.3` +- Kubernetes version: `1.23+` + +CONTAINER IMAGES: + +- Control plane: `ghcr.io/nginxinc/nginx-gateway-fabric:1.1.0` +- Data plane: `ghcr.io/nginxinc/nginx-gateway-fabric/nginx:1.1.0` + ## Release 1.0.0 *October 24, 2023* diff --git a/README.md b/README.md index f5e642949a..12e70ede20 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ You can find the comprehensive NGINX Gateway Fabric user documentation on the [N We publish NGINX Gateway Fabric releases on GitHub. See our [releases page](https://github.com/nginxinc/nginx-gateway-fabric/releases). -The latest release is [1.0.0](https://github.com/nginxinc/nginx-gateway-fabric/releases/tag/v1.0.0). +The latest release is [1.1.0](https://github.com/nginxinc/nginx-gateway-fabric/releases/tag/v1.1.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-gateway-fabric/commits/main) @@ -40,10 +40,10 @@ from the main branch. The table below summarizes the options regarding the images, manifests, documentation and examples and gives your links to the correct versions: -| Version | Description | Installation Manifests | Documentation and Examples | -|----------------|------------------------------------------|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Latest release | For production use | [Manifests](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.0.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.0.0/docs). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.0.0/examples). | -| Edge | For experimental use and latest features | [Manifests](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/deploy). | [Documentation](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/docs). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/examples). | +| Version | Description | Installation Manifests | Documentation and Examples | +|----------------|------------------------------------------|-----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Latest release | For production use | [Manifests](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/deploy). | [Documentation](https://docs.nginx.com/nginx-gateway-fabric). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/examples). | +| Edge | For experimental use and latest features | [Manifests](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/deploy). | [Documentation](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/site/content). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/examples). | ### Versioning @@ -65,6 +65,7 @@ The following table lists the software versions NGINX Gateway Fabric supports. | NGINX Gateway Fabric | Gateway API | Kubernetes | NGINX OSS | |----------------------|-------------|------------|-----------| | Edge | 1.0.0 | 1.23+ | 1.25.3 | +| 1.1.0 | 1.0.0 | 1.23+ | 1.25.3 | | 1.0.0 | 0.8.1 | 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 * | diff --git a/deploy/helm-chart/README.md b/deploy/helm-chart/README.md index d20d60313c..9487941674 100644 --- a/deploy/helm-chart/README.md +++ b/deploy/helm-chart/README.md @@ -37,15 +37,6 @@ This chart deploys the NGINX Gateway Fabric in your Kubernetes cluster. > they are the correct version as supported by the NGINX Gateway Fabric - > [see the Technical Specifications](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/README.md#technical-specifications). -If installing the latest stable release of NGINX Gateway Fabric, ensure you are deploying its supported version of -the Gateway API resources: - - ```shell - kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.8.1/standard-install.yaml - ``` - -If you are installing the edge version of NGINX Gateway Fabric: - ```shell kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml ``` diff --git a/docs/developer/release-process.md b/docs/developer/release-process.md index 10b0dc1773..e1b37b8a83 100644 --- a/docs/developer/release-process.md +++ b/docs/developer/release-process.md @@ -61,7 +61,7 @@ To create a new release, follow these steps: 10. 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). Also update any installation instructions to ensure that the supported Gateway API and NGF versions are correct. Specifically, helm README and `site/content/includes/installation/install-gateway-api-resources.md`. -11. Update the production branch to the latest release branch in [Netlify](https://app.netlify.com/sites/nginx-gateway-fabric/configuration/deploys#branches-and-deploy-contexts). If it's your first time, log in using Gitlab SSO and ask the docs team for permission to access the NGF project. Ensure that once the branch is updated, the deployment pipeline in Netlify passes and that the published docs look good (no obvious errors or issues). +11. Update the production branch to the latest release branch in [Netlify](https://app.netlify.com/sites/nginx-gateway-fabric/configuration/deploys#branches-and-deploy-contexts). If it's your first time, log in using Gitlab SSO and ask the docs team for permission to access the NGF project. Once the branch is updated, redeploy the docs in Netlify. Verify that the Netlify deploy passes and that the published docs look good (no obvious errors or issues). 12. Close the issue created in Step 1. 13. Ensure that the [associated milestone](https://github.com/nginxinc/nginx-gateway-fabric/milestones) is closed. 14. Verify that published artifacts in the release can be installed properly. diff --git a/examples/http-header-filter/README.md b/examples/http-header-filter/README.md index 11b32c43e7..fcb8ea1e6f 100644 --- a/examples/http-header-filter/README.md +++ b/examples/http-header-filter/README.md @@ -72,6 +72,7 @@ Headers: header 'My-cool-header' is 'my-client-value, this-is-an-appended-value' header 'My-Overwrite-Header' is 'this-is-the-only-value' header 'Host' is 'echo.example.com:$GW_PORT' + header 'X-Forwarded-For' is '$GW_IP' header 'Connection' is 'close' header 'Accept' is '*/*' ``` diff --git a/site/content/includes/installation/install-gateway-api-resources.md b/site/content/includes/installation/install-gateway-api-resources.md index 8ceb6195f2..3636897b2f 100644 --- a/site/content/includes/installation/install-gateway-api-resources.md +++ b/site/content/includes/installation/install-gateway-api-resources.md @@ -4,18 +4,7 @@ docs: {{}}The [Gateway API resources](https://github.com/kubernetes-sigs/gateway-api) from the standard channel must be installed before deploying NGINX Gateway Fabric. If they are already installed in your cluster, please ensure they are the correct version as supported by the NGINX Gateway Fabric - [see the Technical Specifications](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/README.md#technical-specifications).{{}} -**Stable release** - -If installing the latest stable release of NGINX Gateway Fabric, ensure you are deploying its supported version of -the Gateway API resources: - -```shell -kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.8.1/standard-install.yaml -``` - -**Edge version** - -If installing the edge version of NGINX Gateway Fabric from the **main** branch: +To install the Gateway API resources, run the following: ```shell kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml diff --git a/site/content/includes/installation/uninstall-gateway-api-resources.md b/site/content/includes/installation/uninstall-gateway-api-resources.md index d0f878670c..87b648d572 100644 --- a/site/content/includes/installation/uninstall-gateway-api-resources.md +++ b/site/content/includes/installation/uninstall-gateway-api-resources.md @@ -4,25 +4,12 @@ docs: {{}}This will remove all corresponding custom resources in your entire cluster, across all namespaces. Double-check to make sure you don't have any custom resources you need to keep, and confirm that there are no other Gateway API implementations active in your cluster.{{}} - To uninstall the Gateway API resources, including the CRDs and the validating webhook, run the following: - - **Stable release** - - If you were running the latest stable release version of NGINX Gateway Fabric: - - ```shell - kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.8.1/standard-install.yaml - ``` - - **Edge version** - - If you were running the edge version of NGINX Gateway Fabric from the **main** branch: + To uninstall the Gateway API resources, run the following: ```shell kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml ``` - If you are running on Kubernetes 1.23 or 1.24, you also need to delete the validating webhook. To do so, run: ```shell