From 9ed207e76c1cc673735693b4ff7205a92429e6d9 Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Wed, 13 Dec 2023 12:52:02 -0700 Subject: [PATCH 01/11] Prepare 1.1 Release --- CHANGELOG.md | 46 +++++++++++++++++++ Makefile | 2 +- README.md | 5 +- conformance/Makefile | 2 +- conformance/provisioner/provisioner.yaml | 2 +- .../provisioner/static-deployment.yaml | 10 ++-- deploy/helm-chart/Chart.yaml | 8 ++-- deploy/helm-chart/README.md | 9 ---- deploy/helm-chart/values.yaml | 8 ++-- deploy/manifests/nginx-gateway.yaml | 20 ++++---- .../service/loadbalancer-aws-nlb.yaml | 2 +- deploy/manifests/service/loadbalancer.yaml | 2 +- deploy/manifests/service/nodeport.yaml | 2 +- docs/developer/release-process.md | 2 +- examples/http-header-filter/README.md | 1 + .../traffic-management/advanced-routing.md | 4 +- .../install-gateway-api-resources.md | 8 ---- .../uninstall-gateway-api-resources.md | 13 ------ .../installation/building-the-images.md | 8 ++-- .../installation/installing-ngf/manifests.md | 34 ++++++++------ 20 files changed, 106 insertions(+), 82 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dd8485a7fe..6cca2eea29 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,52 @@ 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 13, 2023* + +This is the official v1.1.0 release of 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) +- Fix attaching of HTTPRoutes to Gateway Listeners. [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). + +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/Makefile b/Makefile index 3a126989dd..9852a25066 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ # variables that should not be overridden by the user -VERSION = edge +VERSION = 1.1.0 GIT_COMMIT = $(shell git rev-parse HEAD || echo "unknown") DATE = $(shell date -u +"%Y-%m-%dT%H:%M:%SZ") MANIFEST_DIR = $(shell pwd)/deploy/manifests diff --git a/README.md b/README.md index f5e642949a..0a19ff5970 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) @@ -42,7 +42,7 @@ 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). | +| Latest release | For production use | [Manifests](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/docs). [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/docs). [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/conformance/Makefile b/conformance/Makefile index 9e19179450..4ece1bfcc5 100644 --- a/conformance/Makefile +++ b/conformance/Makefile @@ -1,4 +1,4 @@ -TAG = edge +TAG = 1.1.0 PREFIX = nginx-gateway-fabric NGINX_PREFIX = $(PREFIX)/nginx GW_API_VERSION ?= 1.0.0 diff --git a/conformance/provisioner/provisioner.yaml b/conformance/provisioner/provisioner.yaml index 5862ee37ec..7b7269360d 100644 --- a/conformance/provisioner/provisioner.yaml +++ b/conformance/provisioner/provisioner.yaml @@ -68,7 +68,7 @@ spec: spec: serviceAccountName: nginx-gateway-provisioner containers: - - image: ghcr.io/nginxinc/nginx-gateway-fabric:edge + - image: ghcr.io/nginxinc/nginx-gateway-fabric:1.1.0 imagePullPolicy: Always name: nginx-gateway-provisioner securityContext: diff --git a/conformance/provisioner/static-deployment.yaml b/conformance/provisioner/static-deployment.yaml index c6b2326b04..3bfc39c6c3 100644 --- a/conformance/provisioner/static-deployment.yaml +++ b/conformance/provisioner/static-deployment.yaml @@ -8,7 +8,7 @@ metadata: labels: app.kubernetes.io/name: nginx-gateway app.kubernetes.io/instance: nginx-gateway - app.kubernetes.io/version: "edge" + app.kubernetes.io/version: "1.1.0" spec: replicas: 1 selector: @@ -44,8 +44,8 @@ spec: valueFrom: fieldRef: fieldPath: metadata.name - image: ghcr.io/nginxinc/nginx-gateway-fabric:edge - imagePullPolicy: Always + image: ghcr.io/nginxinc/nginx-gateway-fabric:1.1.0 + imagePullPolicy: IfNotPresent name: nginx-gateway ports: - name: health @@ -73,8 +73,8 @@ spec: mountPath: /etc/nginx/secrets - name: nginx-run mountPath: /var/run/nginx - - image: ghcr.io/nginxinc/nginx-gateway-fabric/nginx:edge - imagePullPolicy: Always + - image: ghcr.io/nginxinc/nginx-gateway-fabric/nginx:1.1.0 + imagePullPolicy: IfNotPresent name: nginx ports: - containerPort: 80 diff --git a/deploy/helm-chart/Chart.yaml b/deploy/helm-chart/Chart.yaml index 4ed9e9590d..99d05b63a3 100644 --- a/deploy/helm-chart/Chart.yaml +++ b/deploy/helm-chart/Chart.yaml @@ -2,12 +2,12 @@ apiVersion: v2 name: nginx-gateway-fabric description: NGINX Gateway Fabric type: application -version: 1.0.0 -appVersion: "edge" +version: 1.1.0 +appVersion: "1.1.0" home: https://github.com/nginxinc/nginx-gateway-fabric -icon: https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/main/deploy/helm-chart/chart-icon.png +icon: https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.1.0/deploy/helm-chart/chart-icon.png sources: - - https://github.com/nginxinc/nginx-gateway-fabric/tree/main/deploy/helm-chart + - https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/deploy/helm-chart keywords: - kubernetes - gateway 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/deploy/helm-chart/values.yaml b/deploy/helm-chart/values.yaml index 32fdb5db68..0219f30a67 100644 --- a/deploy/helm-chart/values.yaml +++ b/deploy/helm-chart/values.yaml @@ -38,8 +38,8 @@ nginxGateway: image: ## The NGINX Gateway Fabric image to use repository: ghcr.io/nginxinc/nginx-gateway-fabric - tag: edge - pullPolicy: Always + tag: 1.1.0 + pullPolicy: IfNotPresent securityContext: ## Some environments may need this set to true in order for the control plane to successfully reload NGINX. @@ -55,8 +55,8 @@ nginx: ## The NGINX image to use image: repository: ghcr.io/nginxinc/nginx-gateway-fabric/nginx - tag: edge - pullPolicy: Always + tag: 1.1.0 + pullPolicy: IfNotPresent ## The lifecycle of the nginx container. lifecycle: {} diff --git a/deploy/manifests/nginx-gateway.yaml b/deploy/manifests/nginx-gateway.yaml index 80fc304c05..2a6130cd89 100644 --- a/deploy/manifests/nginx-gateway.yaml +++ b/deploy/manifests/nginx-gateway.yaml @@ -12,7 +12,7 @@ metadata: labels: app.kubernetes.io/name: nginx-gateway app.kubernetes.io/instance: nginx-gateway - app.kubernetes.io/version: "edge" + app.kubernetes.io/version: "1.1.0" annotations: {} --- @@ -24,7 +24,7 @@ metadata: labels: app.kubernetes.io/name: nginx-gateway app.kubernetes.io/instance: nginx-gateway - app.kubernetes.io/version: "edge" + app.kubernetes.io/version: "1.1.0" rules: - apiGroups: - "" @@ -105,7 +105,7 @@ metadata: labels: app.kubernetes.io/name: nginx-gateway app.kubernetes.io/instance: nginx-gateway - app.kubernetes.io/version: "edge" + app.kubernetes.io/version: "1.1.0" roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole @@ -124,7 +124,7 @@ metadata: labels: app.kubernetes.io/name: nginx-gateway app.kubernetes.io/instance: nginx-gateway - app.kubernetes.io/version: "edge" + app.kubernetes.io/version: "1.1.0" spec: replicas: 1 selector: @@ -163,8 +163,8 @@ spec: valueFrom: fieldRef: fieldPath: metadata.name - image: ghcr.io/nginxinc/nginx-gateway-fabric:edge - imagePullPolicy: Always + image: ghcr.io/nginxinc/nginx-gateway-fabric:1.1.0 + imagePullPolicy: IfNotPresent name: nginx-gateway ports: - name: metrics @@ -194,8 +194,8 @@ spec: mountPath: /etc/nginx/secrets - name: nginx-run mountPath: /var/run/nginx - - image: ghcr.io/nginxinc/nginx-gateway-fabric/nginx:edge - imagePullPolicy: Always + - image: ghcr.io/nginxinc/nginx-gateway-fabric/nginx:1.1.0 + imagePullPolicy: IfNotPresent name: nginx ports: - containerPort: 80 @@ -248,7 +248,7 @@ metadata: labels: app.kubernetes.io/name: nginx-gateway app.kubernetes.io/instance: nginx-gateway - app.kubernetes.io/version: "edge" + app.kubernetes.io/version: "1.1.0" spec: controllerName: gateway.nginx.org/nginx-gateway-controller --- @@ -261,7 +261,7 @@ metadata: labels: app.kubernetes.io/name: nginx-gateway app.kubernetes.io/instance: nginx-gateway - app.kubernetes.io/version: "edge" + app.kubernetes.io/version: "1.1.0" spec: logging: level: info diff --git a/deploy/manifests/service/loadbalancer-aws-nlb.yaml b/deploy/manifests/service/loadbalancer-aws-nlb.yaml index ab64f656cf..8e7554fd79 100644 --- a/deploy/manifests/service/loadbalancer-aws-nlb.yaml +++ b/deploy/manifests/service/loadbalancer-aws-nlb.yaml @@ -8,7 +8,7 @@ metadata: labels: app.kubernetes.io/name: nginx-gateway app.kubernetes.io/instance: nginx-gateway - app.kubernetes.io/version: "edge" + app.kubernetes.io/version: "1.1.0" annotations: service.beta.kubernetes.io/aws-load-balancer-type: nlb spec: diff --git a/deploy/manifests/service/loadbalancer.yaml b/deploy/manifests/service/loadbalancer.yaml index 660a236579..93eb7bc361 100644 --- a/deploy/manifests/service/loadbalancer.yaml +++ b/deploy/manifests/service/loadbalancer.yaml @@ -8,7 +8,7 @@ metadata: labels: app.kubernetes.io/name: nginx-gateway app.kubernetes.io/instance: nginx-gateway - app.kubernetes.io/version: "edge" + app.kubernetes.io/version: "1.1.0" spec: externalTrafficPolicy: Local type: LoadBalancer diff --git a/deploy/manifests/service/nodeport.yaml b/deploy/manifests/service/nodeport.yaml index 83c236da7d..73c85f5b6a 100644 --- a/deploy/manifests/service/nodeport.yaml +++ b/deploy/manifests/service/nodeport.yaml @@ -8,7 +8,7 @@ metadata: labels: app.kubernetes.io/name: nginx-gateway app.kubernetes.io/instance: nginx-gateway - app.kubernetes.io/version: "edge" + app.kubernetes.io/version: "1.1.0" spec: type: NodePort selector: diff --git a/docs/developer/release-process.md b/docs/developer/release-process.md index 10b0dc1773..f982fe2eed 100644 --- a/docs/developer/release-process.md +++ b/docs/developer/release-process.md @@ -31,7 +31,7 @@ To create a new release, follow these steps: branch, and the [example applications](/examples). 4. If a problem is found, prepare a fix PR, merge it into the main branch and return to the previous step. 5. If the supported Gateway API minor version has changed since the last release, test NGINX Gateway Fabric with the previous version of the Gateway API CRDs. -6. If a compatibility issue is found, add a note to the release notes explaining that the previous version is not supported. +6. If a compatibility issue is found, add a note to the [changelog](/CHANGELOG.md) explaining that the previous version is not supported. 7. Create a release branch following the `release-X.Y` naming convention. 8. Prepare and merge a PR into the **release branch** to update the repo files for the release: 1. Update the Helm [Chart.yaml](/deploy/helm-chart/Chart.yaml): the `appVersion` to `X.Y.Z`, the icon and source 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/how-to/traffic-management/advanced-routing.md b/site/content/how-to/traffic-management/advanced-routing.md index 53d081a48b..efdb299a34 100644 --- a/site/content/how-to/traffic-management/advanced-routing.md +++ b/site/content/how-to/traffic-management/advanced-routing.md @@ -34,7 +34,7 @@ The goal is to create a set of rules that will result in client requests being s Begin by deploying the `coffee-v1` and `coffee-v2` applications: ```shell -kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/main/examples/advanced-routing/coffee.yaml +kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.1.0/examples/advanced-routing/coffee.yaml ``` ### Deploy the Gateway API Resources for the Coffee Applications @@ -154,7 +154,7 @@ Let's deploy a different set of applications now called `tea` and `tea-post`. Th ### Deploy the Tea Applications ```shell -kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/main/examples/advanced-routing/tea.yaml +kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.1.0/examples/advanced-routing/tea.yaml ``` ### Deploy the HTTPRoute for the Tea Services diff --git a/site/content/includes/installation/install-gateway-api-resources.md b/site/content/includes/installation/install-gateway-api-resources.md index 8ceb6195f2..ff74f1d893 100644 --- a/site/content/includes/installation/install-gateway-api-resources.md +++ b/site/content/includes/installation/install-gateway-api-resources.md @@ -9,14 +9,6 @@ docs: 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: - ```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..d40127fbee 100644 --- a/site/content/includes/installation/uninstall-gateway-api-resources.md +++ b/site/content/includes/installation/uninstall-gateway-api-resources.md @@ -6,23 +6,10 @@ docs: 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: - ```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 diff --git a/site/content/installation/building-the-images.md b/site/content/installation/building-the-images.md index 5c86147229..1fcf73faf0 100644 --- a/site/content/installation/building-the-images.md +++ b/site/content/installation/building-the-images.md @@ -26,7 +26,7 @@ installed on your machine: 1. Clone the repo and change into the `nginx-gateway-fabric` directory: ```shell - git clone https://github.com/nginxinc/nginx-gateway-fabric.git + git clone https://github.com/nginxinc/nginx-gateway-fabric.git --branch v1.1.0 cd nginx-gateway-fabric ``` @@ -50,13 +50,13 @@ installed on your machine: ``` Set the `PREFIX` variable to the name of the registry you'd like to push the image to. By default, the images will be - named `nginx-gateway-fabric:edge` and `nginx-gateway-fabric/nginx:edge`. + named `nginx-gateway-fabric:1.1.0` and `nginx-gateway-fabric/nginx:1.1.0`. 1. Push the images to your container registry: ```shell - docker push myregistry.example.com/nginx-gateway-fabric:edge - docker push myregistry.example.com/nginx-gateway-fabric/nginx:edge + docker push myregistry.example.com/nginx-gateway-fabric:1.1.0 + docker push myregistry.example.com/nginx-gateway-fabric/nginx:1.1.0 ``` Make sure to substitute `myregistry.example.com/nginx-gateway-fabric` with your registry. diff --git a/site/content/installation/installing-ngf/manifests.md b/site/content/installation/installing-ngf/manifests.md index 772edf3a10..673398a426 100644 --- a/site/content/installation/installing-ngf/manifests.md +++ b/site/content/installation/installing-ngf/manifests.md @@ -28,7 +28,7 @@ Deploying NGINX Gateway Fabric with Kubernetes manifests takes only a few steps. #### Stable release ```shell - kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/crds.yaml + kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.1.0/crds.yaml ``` #### Edge version @@ -49,7 +49,7 @@ Deploying NGINX Gateway Fabric with Kubernetes manifests takes only a few steps. #### Stable release ```shell - kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/nginx-gateway.yaml + kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.1.0/nginx-gateway.yaml ``` #### Edge version @@ -107,14 +107,14 @@ To upgrade NGINX Gateway Fabric and get the latest features and improvements, ta - To upgrade the Custom Resource Definitions (CRDs), run: ```shell - kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/crds.yaml + kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.1.0/crds.yaml ``` 1. **Upgrade NGINX Gateway Fabric deployment:** - To upgrade the deployment, run: ```shell - kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/nginx-gateway.yaml + kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.1.0/nginx-gateway.yaml ``` ## Delay pod termination for zero downtime upgrades {#configure-delayed-pod-termination-for-zero-downtime-upgrades} @@ -171,21 +171,27 @@ For additional information on configuring and understanding the behavior of cont Follow these steps to uninstall NGINX Gateway Fabric and Gateway API from your Kubernetes cluster: -1. **Uninstall NGINX Gateway Fabric:** +### 1. Uninstall NGINX Gateway Fabric - - To remove NGINX Gateway Fabric and its custom resource definitions (CRDs), run: +#### Stable release + + ```shell + kubectl delete -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.1.0/nginx-gateway.yaml + ``` + +#### Edge version - ```shell - kubectl delete -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/nginx-gateway.yaml - ``` + ```shell + kubectl delete -f deploy/manifests/nginx-gateway.yaml + ``` - ```shell - kubectl delete -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.0.0/crds.yaml - ``` + ```shell + kubectl delete -f deploy/manifests/crds + ``` -1. **Remove the Gateway API resources:** +### 2. Remove the Gateway API resources - - {{}} +- {{}} ## Next steps From b99ec1da5ce813f21162f40b44a0d17a005fabba Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Wed, 13 Dec 2023 13:43:57 -0700 Subject: [PATCH 02/11] Point to docs.nginx.com in stable release --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a19ff5970..08c963df6c 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ 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.1.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/docs). [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/docs). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/examples). | +| Edge | For experimental use and latest features | [Manifests](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/deploy). | [Documentation](https://docs.nginx.com/nginx-gateway-fabric/). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/examples). | ### Versioning From b6ec2135a64fcc72e02a41fb2f3ddeb73166790a Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Wed, 13 Dec 2023 13:46:56 -0700 Subject: [PATCH 03/11] Fix HTTPRoute bug changelog msg --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6cca2eea29..475316122f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,7 +20,7 @@ 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) -- Fix attaching of HTTPRoutes to Gateway Listeners. [PR-1275](https://github.com/nginxinc/nginx-gateway-fabric/pull/1275) +- 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: From 273873f6020e2279efc22bece547dd0aa8174c9e Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Wed, 13 Dec 2023 14:43:25 -0700 Subject: [PATCH 04/11] Update link to edge docs --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 08c963df6c..838da738cd 100644 --- a/README.md +++ b/README.md @@ -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.1.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/docs). [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://docs.nginx.com/nginx-gateway-fabric/). [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://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/site/content). [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://docs.nginx.com/nginx-gateway-fabric/). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/examples). | ### Versioning From 82ff8b1bd4ee0e462a055ced182e171b19fe075f Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Thu, 14 Dec 2023 10:36:57 -0700 Subject: [PATCH 05/11] Fix edge/stable doc links --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 838da738cd..e607ea0f36 100644 --- a/README.md +++ b/README.md @@ -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.1.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/site/content). [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://docs.nginx.com/nginx-gateway-fabric/). [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 From 3d09cce52e1e22251a644dcffac6f6a14b82250b Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Thu, 14 Dec 2023 10:42:26 -0700 Subject: [PATCH 06/11] Update changelog summary --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 475316122f..8a7db05ee4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,7 @@ and includes links to all PRs that went into the release. *December 13, 2023* -This is the official v1.1.0 release of NGINX Gateway Fabric. +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 docs.nginx.com/nginx-gateway-fabric. FEATURES: From 8db6156a47a9d0117f9494284f2d2efa2497915d Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Thu, 14 Dec 2023 10:49:32 -0700 Subject: [PATCH 07/11] Changlog fixes --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8a7db05ee4..f1b49a40b3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,9 +6,9 @@ and includes links to all PRs that went into the release. ## Release 1.1.0 -*December 13, 2023* +*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 docs.nginx.com/nginx-gateway-fabric. +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: From 4bd86c07549c4a81771f5f4960e674d898f7e64b Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Thu, 14 Dec 2023 10:54:23 -0700 Subject: [PATCH 08/11] Remove edge from tech specs --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index e607ea0f36..d53fb286f7 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,6 @@ 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 | From df9ed45ae7ed8a994bb3572746a9eb3bacf5214d Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Thu, 14 Dec 2023 11:27:38 -0700 Subject: [PATCH 09/11] Fix wording in uninstall and install docs --- .../includes/installation/install-gateway-api-resources.md | 5 +---- .../includes/installation/uninstall-gateway-api-resources.md | 2 +- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/site/content/includes/installation/install-gateway-api-resources.md b/site/content/includes/installation/install-gateway-api-resources.md index ff74f1d893..3636897b2f 100644 --- a/site/content/includes/installation/install-gateway-api-resources.md +++ b/site/content/includes/installation/install-gateway-api-resources.md @@ -4,10 +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: +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 d40127fbee..87b648d572 100644 --- a/site/content/includes/installation/uninstall-gateway-api-resources.md +++ b/site/content/includes/installation/uninstall-gateway-api-resources.md @@ -4,7 +4,7 @@ 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: + 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 From 29fc02c4be4acb6545f3bc319bba7b4204f85ded Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Thu, 14 Dec 2023 12:43:59 -0700 Subject: [PATCH 10/11] Add external PR to changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f1b49a40b3..47a5bb3131 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,6 +34,7 @@ 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-1289](https://github.com/nginxinc/nginx-gateway-fabric/pull/1290). Thanks to [arukiidou](https://github.com/arukiidou). UPGRADE: From 53a2a858a5d9021bbfe6a9f02bbd128568132fae Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Thu, 14 Dec 2023 12:50:31 -0700 Subject: [PATCH 11/11] Fix PR number --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 47a5bb3131..24d147134d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,7 +34,7 @@ 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-1289](https://github.com/nginxinc/nginx-gateway-fabric/pull/1290). Thanks to [arukiidou](https://github.com/arukiidou). +- 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: