Update release version in docs (#2787)

Update release version to 1.5.0
nginxinc · Nov 21, 2024 · 702ec11 · 702ec11
1 parent 9fb7b33
commit 702ec11
Show file tree

Hide file tree

Showing 20 changed files with 139 additions and 73 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,60 @@ 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.5.0
+
+_November 20, 2024_
+
+BREAKING CHANGES:
+
+- NGINX Plus R33 support added. The NGINX Plus release now requires a valid JSON Web Token (JWT) in order to run. Users of NGINX Plus _must_ have this JWT added to a Secret before installing NGINX Gateway Fabric v1.5.0. See the [NGINX Plus JWT](https://docs.nginx.com/nginx-gateway-fabric/installation/nginx-plus-jwt/) guide for information on setting this up. [2760](https://github.com/nginxinc/nginx-gateway-fabric/pull/2760)
+
+FEATURES:
+
+- Add support to retain client IP information. [2284](https://github.com/nginxinc/nginx-gateway-fabric/pull/2284)
+- Add the ability to configure data plane error log level. [2603](https://github.com/nginxinc/nginx-gateway-fabric/pull/2603)
+- Introduce SnippetsFilter API, which allows users to inject custom NGINX configuration via an HTTPRoute or GRPCRoute filter. See the [SnippetsFilter guide](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/snippets/) for information on how to use SnippetsFilters. [2604](https://github.com/nginxinc/nginx-gateway-fabric/pull/2604)
+- Reduce logging verbosity of default Info log level. [2455](https://github.com/nginxinc/nginx-gateway-fabric/pull/2455)
+
+BUG FIXES:
+
+- Stream status_zone directive is no longer set if its value is empty. [2684](https://github.com/nginxinc/nginx-gateway-fabric/pull/2684)
+- Fix an issue with upstream names when split clients are used with a namespace name that starts with a number. [2730](https://github.com/nginxinc/nginx-gateway-fabric/pull/2730)
+- A 503 http response code is now returned to the client when a service has no ready endpoints. [2696](https://github.com/nginxinc/nginx-gateway-fabric/pull/2696)
+
+DOCUMENTATION:
+
+- Add a [guide](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/snippets) for SnippetsFilter. [2721](https://github.com/nginxinc/nginx-gateway-fabric/pull/2721)
+- Add a new [Get started](https://docs.nginx.com/nginx-gateway-fabric/get-started/) document. [2721](https://github.com/nginxinc/nginx-gateway-fabric/pull/2717)
+- Add documentation for [proxyProtocol and rewriteClientIP](https://docs.nginx.com/nginx-gateway-fabric/how-to/data-plane-configuration/#configure-proxy-protocol-and-rewriteclientip-settings) settings. [2701](https://github.com/nginxinc/nginx-gateway-fabric/pull/2701)
+- Fix indentation in lifecycle examples. [2588](https://github.com/nginxinc/nginx-gateway-fabric/pull/2588). Thanks to [Derek F](https://github.com/defrank).
+
+HELM CHART:
+
+- The version of the Helm chart is now 1.5.0
+- Add `loadBalancerSourceRanges` to helm parameters to use during install/upgrade. [2773](https://github.com/nginxinc/nginx-gateway-fabric/pull/2773)
+- Add `loadBalancerIP` as a helm parameter to use during install/upgrade. [2766](https://github.com/nginxinc/nginx-gateway-fabric/pull/2766)
+- Add Helm schema. [2492](https://github.com/nginxinc/nginx-gateway-fabric/pull/2492)
+- Add capability to configure `topologySpreadConstraints`. [2703](https://github.com/nginxinc/nginx-gateway-fabric/pull/2703). Thanks to [Robsta86](https://github.com/Robsta86)
+
+DEPENDENCIES:
+
+- NGINX Plus was updated to R33. [2760](https://github.com/nginxinc/nginx-gateway-fabric/pull/2760)
+- Update to v1.2.0 of the Gateway API. [2694](https://github.com/nginxinc/nginx-gateway-fabric/pull/2694)
+
+COMPATIBILITY:
+
+- Gateway API version: `1.2.0`
+- NGINX version: `1.27.2`
+- NGINX Plus version: `R33`
+- Kubernetes version: `1.25+`
+
+CONTAINER IMAGES:
+
+- Control plane: `ghcr.io/nginxinc/nginx-gateway-fabric:1.5.0`
+- Data plane: `ghcr.io/nginxinc/nginx-gateway-fabric/nginx:1.5.0`
+- Data plane with NGINX Plus: `private-registry.nginx.com/nginx-gateway-fabric/nginx-plus:1.5.0`
+
 ## Release 1.4.0
 
 _August 20, 2024_

diff --git a/README.md b/README.md
@@ -34,7 +34,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.4.0](https://github.com/nginxinc/nginx-gateway-fabric/releases/tag/v1.4.0).
+The latest release is [1.5.0](https://github.com/nginxinc/nginx-gateway-fabric/releases/tag/v1.5.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)
@@ -45,7 +45,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.4.0/deploy). | [Documentation](https://docs.nginx.com/nginx-gateway-fabric). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.4.0/examples).                           |
+| Latest release | For production use                       | [Manifests](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.5.0/deploy). | [Documentation](https://docs.nginx.com/nginx-gateway-fabric). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.5.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
@@ -66,21 +66,13 @@ The following table lists the software versions NGINX Gateway Fabric supports.
 
 | NGINX Gateway Fabric | Gateway API | Kubernetes | NGINX OSS | NGINX Plus |
 |----------------------|-------------|------------|-----------|------------|
-| Edge                 | 1.2.0       | 1.25+      | 1.27.2    | R32        |
+| Edge                 | 1.2.0       | 1.25+      | 1.27.2    | R33        |
+| 1.5.0                | 1.2.0       | 1.25+      | 1.27.2    | R33        |
 | 1.4.0                | 1.1.0       | 1.25+      | 1.27.1    | R32        |
 | 1.3.0                | 1.1.0       | 1.25+      | 1.27.0    | R32        |
 | 1.2.0                | 1.0.0       | 1.23+      | 1.25.4    | R31        |
 | 1.1.0                | 1.0.0       | 1.23+      | 1.25.3    | n/a        |
 | 1.0.0                | 0.8.1       | 1.23+      | 1.25.2    | n/a        |
-| 0.6.0                | 0.8.0       | 1.23+      | 1.25.2    | n/a        |
-| 0.5.0                | 0.7.1       | 1.21+      | 1.25.x \* | n/a        |
-| 0.4.0                | 0.7.1       | 1.21+      | 1.25.x \* | n/a        |
-| 0.3.0                | 0.6.2       | 1.21+      | 1.23.x \* | n/a        |
-| 0.2.0                | 0.5.1       | 1.21+      | 1.21.x \* | n/a        |
-| 0.1.0                | 0.5.0       | 1.19+      | 1.21.3    | n/a        |
-
-\*the installation manifests use the minor version of NGINX container image (e.g. 1.25) and the patch version is not
-specified. This means that the latest available patch version is used.
 
 ## SBOM (Software Bill of Materials)
 

diff --git a/charts/nginx-gateway-fabric/Chart.yaml b/charts/nginx-gateway-fabric/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: nginx-gateway-fabric
 description: NGINX Gateway Fabric
 type: application
-version: 1.4.0
+version: 1.5.0
 appVersion: "edge"
 kubeVersion: ">= 1.25.0-0"
 home: https://github.com/nginxinc/nginx-gateway-fabric

diff --git a/charts/nginx-gateway-fabric/README.md b/charts/nginx-gateway-fabric/README.md
@@ -1,7 +1,7 @@
 
 # NGINX Gateway Fabric Helm Chart
 
-![Version: 1.4.0](https://img.shields.io/badge/Version-1.4.0-informational?style=flat-square) ![AppVersion: edge](https://img.shields.io/badge/AppVersion-edge-informational?style=flat-square)
+![Version: 1.5.0](https://img.shields.io/badge/Version-1.5.0-informational?style=flat-square) ![AppVersion: edge](https://img.shields.io/badge/AppVersion-edge-informational?style=flat-square)
 
 - [NGINX Gateway Fabric Helm Chart](#nginx-gateway-fabric-helm-chart)
   - [Introduction](#introduction)

diff --git a/site/content/get-started.md b/site/content/get-started.md
@@ -53,6 +53,7 @@ Run the following command:
 ```shell
 kind create cluster --config cluster-config.yaml
 ```
+
 ```text
 Creating cluster "kind" ...
  ✓ Ensuring node image (kindest/node:v1.31.0) 🖼
@@ -75,6 +76,7 @@ If you have cloned [the NGINX Gateway Fabric repository](https://github.com/ngin
 ```shell
 make create-kind-cluster
 ```
+
 {{< /note >}}
 
 ---
@@ -86,8 +88,9 @@ make create-kind-cluster
 Use `kubectl` to add the API resources for NGINX Gateway Fabric with the following command:
 
 ```shell
-kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/standard?ref=v1.4.0" | kubectl apply -f -
+kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/standard?ref=v1.5.0" | kubectl apply -f -
 ```
+
 ```text
 customresourcedefinition.apiextensions.k8s.io/gatewayclasses.gateway.networking.k8s.io created
 customresourcedefinition.apiextensions.k8s.io/gateways.gateway.networking.k8s.io created
@@ -100,8 +103,9 @@ customresourcedefinition.apiextensions.k8s.io/referencegrants.gateway.networking
 To use experimental features, you'll need to install the API resources from the experimental channel instead.
 
 ```shell
-kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/experimental?ref=v1.4.0" | kubectl apply -f -
+kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/experimental?ref=v1.5.0" | kubectl apply -f -
 ```
+
 {{< /note >}}
 
 ---
@@ -113,8 +117,9 @@ Use `helm` to install NGINX Gateway Fabric with the following command:
 ```shell
 helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-namespace -n nginx-gateway --set service.create=false
 ```
+
 ```text
-Pulled: ghcr.io/nginxinc/charts/nginx-gateway-fabric:1.4.0
+Pulled: ghcr.io/nginxinc/charts/nginx-gateway-fabric:1.5.0
 Digest: sha256:9bbd1a2fcbfd5407ad6be39f796f582e6263512f1f3a8969b427d39063cc6fee
 NAME: ngf
 LAST DEPLOYED: Mon Oct 21 14:45:14 2024
@@ -130,6 +135,7 @@ If you installed the API resources from the experimental channel during the last
 ```shell
 helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-namespace -n nginx-gateway --set service.create=false --set nginxGateway.gwAPIExperimentalFeatures.enable=true
 ```
+
 {{< /note >}}
 
 ---
@@ -151,7 +157,7 @@ metadata:
   labels:
     app.kubernetes.io/name: nginx-gateway-fabric
     app.kubernetes.io/instance: ngf
-    app.kubernetes.io/version: "1.4.0"
+    app.kubernetes.io/version: "1.5.0"
 spec:
   type: NodePort
   selector:
@@ -175,6 +181,7 @@ Apply it using `kubectl`:
 ```shell
 kubectl apply -f nodeport-config.yaml
 ```
+
 ```text
 service/nginx-gateway created
 ```
@@ -201,13 +208,14 @@ The YAML code in the following sections can be found in the [cafe-example folder
 
 Create the file _cafe.yaml_ with the following contents:
 
-{{< ghcode "https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/cafe.yaml">}}
+{{< ghcode `https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/cafe.yaml`>}}
 
-Apply it:
+Apply it using `kubectl`:
 
 ```shell
 kubectl apply -f cafe.yaml
 ```
+
 ```text
 deployment.apps/coffee created
 service/coffee created
@@ -220,6 +228,7 @@ Verify that the new pods are in the `default` namespace:
 ```shell
 kubectl -n default get pods
 ```
+
 ```text
 NAME                      READY   STATUS    RESTARTS   AGE
 coffee-6db967495b-wk2mm   1/1     Running   0          10s
@@ -232,26 +241,28 @@ tea-7b7d6c947d-d4qcf      1/1     Running   0          10s
 
 Create the file _gateway.yaml_ with the following contents:
 
-{{< ghcode "https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/gateway.yaml">}}
+{{< ghcode `https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/gateway.yaml`>}}
 
 Apply it using `kubectl`:
 
 ```shell
 kubectl apply -f gateway.yaml
 ```
+
 ```text
 gateway.gateway.networking.k8s.io/gateway created
 ```
 
 Create the file _cafe-routes.yaml_ with the following contents:
 
-{{< ghcode "https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/cafe-routes.yaml">}}
+{{< ghcode `https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/refs/heads/main/examples/cafe-example/cafe-routes.yaml`>}}
 
 Apply it using `kubectl`:
 
 ```shell
 kubectl apply -f cafe-routes.yaml
 ```
+
 ```text
 httproute.gateway.networking.k8s.io/coffee created
 httproute.gateway.networking.k8s.io/tea created
@@ -266,6 +277,7 @@ You can check that all of the expected services are available using `kubectl get
 ```shell
 kubectl get service --all-namespaces
 ```
+
 ```text
 NAMESPACE       NAME            TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)                      AGE
 default         coffee          ClusterIP   10.96.18.163    <none>        80/TCP                       2m51s
@@ -280,6 +292,7 @@ You can also use `kubectl describe` on the new resources to check their status:
 ```shell
 kubectl describe httproutes
 ```
+
 ```text
 Name:         coffee
 Namespace:    default
@@ -394,6 +407,7 @@ Events:              <none>
 ```shell
 kubectl describe gateways
 ```
+
 ```text
 Name:         gateway
 Namespace:    default
@@ -480,6 +494,7 @@ You can use `curl` to test the new services by targeting the hostname (_cafe.exa
 ```shell
 curl --resolve cafe.example.com:8080:127.0.0.1 http://cafe.example.com:8080/coffee
 ```
+
 ```text
 Server address: 10.244.0.6:8080
 Server name: coffee-6db967495b-wk2mm
@@ -491,6 +506,7 @@ Request ID: fb226a54fd94f927b484dd31fb30e747
 ```shell
 curl --resolve cafe.example.com:8080:127.0.0.1 http://cafe.example.com:8080/tea
 ```
+
 ```text
 Server address: 10.244.0.7:8080
 Server name: tea-7b7d6c947d-d4qcf

diff --git a/site/content/how-to/monitoring/prometheus.md b/site/content/how-to/monitoring/prometheus.md
@@ -102,11 +102,11 @@ You can configure monitoring metrics for NGINX Gateway Fabric using Helm or Mani
 
 ### Using Helm
 
-If you're setting up NGINX Gateway Fabric with Helm, you can adjust the `metrics.*` parameters to fit your needs. For detailed options and instructions, see the [Helm README](https://github.com/nginxinc/nginx-gateway-fabric/blob/v1.4.0/charts/nginx-gateway-fabric/README.md).
+If you're setting up NGINX Gateway Fabric with Helm, you can adjust the `metrics.*` parameters to fit your needs. For detailed options and instructions, see the [Helm README](https://github.com/nginxinc/nginx-gateway-fabric/blob/v1.5.0/charts/nginx-gateway-fabric/README.md).
 
 ### Using Kubernetes manifests
 
-For setups using Kubernetes manifests, change the metrics configuration by editing the NGINX Gateway Fabric manifest that you want to deploy. You can find some examples in the [deploy](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.4.0/deploy) directory.
+For setups using Kubernetes manifests, change the metrics configuration by editing the NGINX Gateway Fabric manifest that you want to deploy. You can find some examples in the [deploy](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.5.0/deploy) directory.
 
 #### Disabling metrics
 

diff --git a/site/content/how-to/traffic-management/advanced-routing.md b/site/content/how-to/traffic-management/advanced-routing.md
@@ -36,7 +36,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/v1.4.0/examples/advanced-routing/coffee.yaml
+kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.5.0/examples/advanced-routing/coffee.yaml
 ```
 
 ### Deploy the Gateway API Resources for the Coffee applications
@@ -156,7 +156,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/v1.4.0/examples/advanced-routing/tea.yaml
+kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.5.0/examples/advanced-routing/tea.yaml
 ```
 
 ### Deploy the HTTPRoute for the Tea services

diff --git a/site/content/how-to/traffic-management/client-settings.md b/site/content/how-to/traffic-management/client-settings.md
@@ -45,19 +45,19 @@ For all the possible configuration options for `ClientSettingsPolicy`, see the [
 - Create the coffee and tea example applications:
 
   ```yaml
-  kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.4.0/examples/client-settings-policy/app.yaml
+  kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.5.0/examples/client-settings-policy/app.yaml
   ```
 
 - Create a Gateway:
 
   ```yaml
-  kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.4.0/examples/client-settings-policy/gateway.yaml
+  kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.5.0/examples/client-settings-policy/gateway.yaml
    ```
 
 - Create HTTPRoutes for the coffee and tea applications:
 
   ```yaml
-  kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.4.0/examples/client-settings-policy/httproutes.yaml
+  kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.5.0/examples/client-settings-policy/httproutes.yaml
    ```
 
 - Test the configuration: