Skip to content

Commit 6c3921a

Browse files
kate-osbornkate-osborn
authored
Update docs for 1.3 release (#2125)
Problem: The 1.3 release is out, but the docs still point to 1.2 as the latest version. Solution: Update the docs to point to 1.3 as the latest version.
1 parent 3d7e963 commit 6c3921a

File tree

17 files changed

+133
-63
lines changed

17 files changed

+133
-63
lines changed

‎CHANGELOG.md

Lines changed: 84 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,79 @@ This document includes a curated changelog for each release. We also publish a c
44
a [GitHub release](https://github.com/nginxinc/nginx-gateway-fabric/releases), which, by contrast, is auto-generated
55
and includes links to all PRs that went into the release.
66

7+
## Release 1.3.0
8+
9+
_June 11, 2024_
10+
11+
FEATURES:
12+
13+
- Support for [GRPCRoute](https://gateway-api.sigs.k8s.io/api-types/grpcroute/):
14+
- Exact Method Matching, Header Matching, and Listener Hostname Matching. [1835](https://github.com/nginxinc/nginx-gateway-fabric/pull/1835)
15+
- RequestHeaderModifier Filter. [1909](https://github.com/nginxinc/nginx-gateway-fabric/pull/1909)
16+
- ResponseHeaderModifier filter. [1983](https://github.com/nginxinc/nginx-gateway-fabric/pull/1983)
17+
- Support tracing via the ObservabilityPolicy CRD. [2004](https://github.com/nginxinc/nginx-gateway-fabric/pull/2004)
18+
- NginxProxy CRD added to configure global settings (such as tracing endpoint) at the GatewayClass level. [1870](https://github.com/nginxinc/nginx-gateway-fabric/pull/1870)
19+
- Add configuration option to disable HTTP2 to the NginxProxy CRD. [1925](https://github.com/nginxinc/nginx-gateway-fabric/pull/1925)
20+
- Introduce ClientSettingsPolicy CRD. This CRD allows users to configure the behavior of the connection between the client and NGINX. [1940](https://github.com/nginxinc/nginx-gateway-fabric/pull/1940)
21+
- Introduce support for the HTTP filter `ResponseHeaderModifier`, enabling the modification of response headers within HTTPRoutes. [1880](https://github.com/nginxinc/nginx-gateway-fabric/pull/1880). With help from [Kai-Hsun Chen](https://github.com/kevin85421).
22+
- Collect BackendTLSPolicy and GRPCRoute counts configured with NGINX Gateway Fabric. [1954](https://github.com/nginxinc/nginx-gateway-fabric/pull/1954)
23+
24+
BUG FIXES:
25+
26+
- Remove zone size for invalid backend ref. [1931](https://github.com/nginxinc/nginx-gateway-fabric/pull/1931)
27+
- Fixed issue when using BackendTLSPolicy that led to failed connections. [1934](https://github.com/nginxinc/nginx-gateway-fabric/pull/1934).
28+
- Update secrets on resource version change only. [2047](https://github.com/nginxinc/nginx-gateway-fabric/pull/2047)
29+
- Fix reload errors due to long matching conditions. [1829](https://github.com/nginxinc/nginx-gateway-fabric/pull/1829).
30+
- Add SecurityContextConstraints so NGF can run on Openshift. [1976](https://github.com/nginxinc/nginx-gateway-fabric/pull/1976)
31+
32+
DOCUMENTATION:
33+
34+
- Helm docs are now automatically generated. [2058](https://github.com/nginxinc/nginx-gateway-fabric/pull/2058)
35+
- Add [guide](https://docs.nginx.com/nginx-gateway-fabric/how-to/monitoring/tracing/) on how to configure tracing for HTTPRoutes and GRPCRoutes. [2026](https://github.com/nginxinc/nginx-gateway-fabric/pull/2026).
36+
- Add [guide](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/client-settings/) on how to use the ClientSettingsPolicy API. [2071](https://github.com/nginxinc/nginx-gateway-fabric/pull/2071).
37+
- Document how to upgrade from Open Source NGINX to NGINX Plus. [2104](https://github.com/nginxinc/nginx-gateway-fabric/pull/2104)
38+
- Add [overview](https://docs.nginx.com/nginx-gateway-fabric/overview/custom-policies) of how custom policies work in NGINX Gateway Fabric. [2088](https://github.com/nginxinc/nginx-gateway-fabric/pull/2088)
39+
40+
HELM CHART:
41+
42+
- The version of the Helm chart is now 1.3.0
43+
- Specify minimum Kubernetes version in Helm chart. [1885](https://github.com/nginxinc/nginx-gateway-fabric/pull/1885)
44+
- Use kustomize to install Gateway API and NGINX Gateway Fabric CRDs. [1886](https://github.com/nginxinc/nginx-gateway-fabric/pull/1886) and [2011](https://github.com/nginxinc/nginx-gateway-fabric/pull/2011)
45+
- Annotations for GatewayClass and NginxGateway are now configurable. [1993](https://github.com/nginxinc/nginx-gateway-fabric/pull/1993). Thanks to [sgavrylenko](https://github.com/sgavrylenko).
46+
- Fix RBAC ServiceAccount ImagePullSecrets template which caused errors when running NGF with NGINX+. [1953](https://github.com/nginxinc/nginx-gateway-fabric/pull/1953)
47+
48+
DEPENDENCIES:
49+
50+
- The minimum supported version of Kubernetes is now 1.25. [1885](https://github.com/nginxinc/nginx-gateway-fabric/pull/1885)
51+
- NGINX Plus was updated to R32. [2057](https://github.com/nginxinc/nginx-gateway-fabric/pull/2057)
52+
- Update to v1.1.0 of the Gateway API. This includes a breaking change to BackendTLSPolicies - see [the release notes](https://github.com/kubernetes-sigs/gateway-api/releases/tag/v1.1.0) for further details. [1975](https://github.com/nginxinc/nginx-gateway-fabric/pull/1975)
53+
54+
UPGRADE:
55+
56+
- This version of NGINX Gateway Fabric is not compatible with v1.0.0 of the Gateway API. You must upgrade the Gateway API CRDs to v1.1.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). If you are using the v1.0.0 or earlier experimental versions of GRPCRoute or BackendTLSPolicy, see [v1.1.0 Upgrade Notes](https://gateway-api.sigs.k8s.io/guides/#v11-upgrade-notes) for instructions on upgrading the Gateway API CRDs.
57+
58+
KNOWN ISSUES:
59+
60+
- Tracing does not work on HTTPRoutes with matching conditions. [2105](https://github.com/nginxinc/nginx-gateway-fabric/issues/2105)
61+
- ClientSettingsPolicy does not work on HTTPRoutes with matching conditions. [2079](https://github.com/nginxinc/nginx-gateway-fabric/issues/2079)
62+
- In restrictive environments, the NGF Pod may fail to become ready due to a permissions issue that causes nginx reloads to fail. [1695](https://github.com/nginxinc/nginx-gateway-fabric/issues/1695)
63+
64+
COMPATIBILITY:
65+
66+
- The Gateway API version: `1.1.0`. This release is not compatible with v1.0.0 of the Gateway API. See the UPGRADE section above for instructions on how to upgrade.
67+
- NGINX version: `1.27.0`
68+
- NGINX Plus version: `R32`
69+
- Kubernetes version: `1.25+`
70+
71+
CONTAINER IMAGES:
72+
73+
- Control plane: `ghcr.io/nginxinc/nginx-gateway-fabric:1.3.0`
74+
- Data plane: `ghcr.io/nginxinc/nginx-gateway-fabric/nginx:1.3.0`
75+
- Data plane with NGINX Plus: `private-registry.nginx.com/nginx-gateway-fabric/nginx-plus:1.3.0`
76+
777
## Release 1.2.0
878

9-
*March 21, 2024*
79+
_March 21, 2024_
1080

1181
FEATURES:
1282

@@ -59,7 +129,7 @@ CONTAINER IMAGES:
59129

60130
## Release 1.1.0
61131

62-
*December 14, 2023*
132+
_December 14, 2023_
63133

64134
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.
65135

@@ -106,7 +176,7 @@ CONTAINER IMAGES:
106176

107177
## Release 1.0.0
108178

109-
*October 24, 2023*
179+
_October 24, 2023_
110180

111181
This is the official v1.0.0 release of NGINX Gateway Fabric.
112182

@@ -147,7 +217,7 @@ CONTAINER IMAGES:
147217

148218
## Release 0.6.0
149219

150-
*August 31, 2023*
220+
_August 31, 2023_
151221

152222
This release adds a Helm chart, dynamic control plane logging, Prometheus metrics, and in-depth guides for various use cases.
153223

@@ -180,7 +250,7 @@ CONTAINER IMAGES:
180250

181251
## Release 0.5.0
182252

183-
*July 17, 2023*
253+
_July 17, 2023_
184254

185255
This release completes all v1beta1 Core features of the Gateway API resources. See the [Gateway Compatibility doc](https://github.com/nginxinc/nginx-gateway-fabric/blob/v0.5.0/docs/gateway-api-compatibility.md)
186256

@@ -199,7 +269,7 @@ BUG FIXES:
199269
COMPATIBILITY:
200270

201271
- The Gateway API version: `0.7.1`
202-
- NGINX version: `1.25.x` *
272+
- NGINX version: `1.25.x` \*
203273
- Kubernetes version: `1.21+`
204274

205275
\*the installation manifests use the `nginx:1.25` image, which always points to the latest version of 1.25.x releases.
@@ -210,7 +280,7 @@ CONTAINER IMAGES:
210280

211281
## Release 0.4.0
212282

213-
*July 6, 2023*
283+
_July 6, 2023_
214284

215285
This release brings:
216286

@@ -258,7 +328,7 @@ DEPENDENCIES:
258328
COMPATIBILITY:
259329

260330
- The Gateway API version: `0.7.1`
261-
- NGINX version: `1.25.x` *
331+
- NGINX version: `1.25.x` \*
262332
- Kubernetes version: `1.21+`
263333

264334
\*the installation manifests use the `nginx:1.25` image, which always points to the latest version of 1.25.x releases.
@@ -269,12 +339,12 @@ CONTAINER IMAGES:
269339

270340
## Release 0.3.0
271341

272-
*April 24, 2023*
342+
_April 24, 2023_
273343

274344
This release brings:
275345

276346
- Extensive validation of Gateway API resources for robustness, security and correctness. See the [validation doc](https://github.com/nginxinc/nginx-gateway-fabric/blob/v0.3.0/docs/resource-validation.md)
277-
for more details.
347+
for more details.
278348
- Defined open-source development process for NGINX Kubernetes Gateway project. See the [Issue lifecycle doc](https://github.com/nginxinc/nginx-gateway-fabric/blob/v0.3.0/ISSUE_LIFECYCLE.md).
279349
- Miscellaneous enhancements and bug fixes.
280350

@@ -304,7 +374,7 @@ DEPENDENCIES:
304374
COMPATIBILITY:
305375

306376
- The Gateway API version: `0.6.2`
307-
- NGINX version: `1.23.x` *
377+
- NGINX version: `1.23.x` \*
308378
- Kubernetes version: `1.21+`
309379

310380
\*the installation manifests use the `nginx:1.23` image, which always points to the latest version of 1.23.x releases.
@@ -315,7 +385,7 @@ CONTAINER IMAGES:
315385

316386
## Release 0.2.0
317387

318-
*October 25, 2022*
388+
_October 25, 2022_
319389

320390
This release extends the support of the features of the Gateway API resources.
321391

@@ -339,11 +409,10 @@ DEPENDENCIES:
339409
- Use the latest NGINX 1.23 image. [PR-275](https://github.com/nginxinc/nginx-gateway-fabric/pull/275)
340410
- Bump sigs.k8s.io/gateway-api from 0.5.0 to 0.5.1 [PR-251](https://github.com/nginxinc/nginx-gateway-fabric/pull/251)
341411

342-
343412
COMPATIBILITY:
344413

345414
- The Gateway API version: `0.5.1`
346-
- NGINX version: `1.21.x` *
415+
- NGINX version: `1.21.x` \*
347416
- Kubernetes version: `1.21+`
348417

349418
\*the installation manifests use the `nginx:1.21` image, which always points to the latest version of 1.21.x releases.
@@ -354,7 +423,7 @@ CONTAINER IMAGES:
354423

355424
## Release 0.1.0
356425

357-
*August 22, 2022*
426+
_August 22, 2022_
358427

359428
This is an initial release of NGINX Kubernetes Gateway project.
360429

‎README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ You can find the comprehensive NGINX Gateway Fabric user documentation on the [N
3434
We publish NGINX Gateway Fabric releases on GitHub. See
3535
our [releases page](https://github.com/nginxinc/nginx-gateway-fabric/releases).
3636

37-
The latest release is [1.2.0](https://github.com/nginxinc/nginx-gateway-fabric/releases/tag/v1.2.0).
37+
The latest release is [1.3.0](https://github.com/nginxinc/nginx-gateway-fabric/releases/tag/v1.3.0).
3838

3939
The edge version is useful for experimenting with new features that are not yet published in a release. To use, choose
4040
the _edge_ version built from the [latest commit](https://github.com/nginxinc/nginx-gateway-fabric/commits/main)
@@ -44,8 +44,8 @@ The table below summarizes the options regarding the images, manifests, document
4444
to the correct versions:
4545

4646
| Version | Description | Installation Manifests | Documentation and Examples |
47-
| -------------- | ---------------------------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
48-
| Latest release | For production use | [Manifests](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.2.0/deploy). | [Documentation](https://docs.nginx.com/nginx-gateway-fabric). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.2.0/examples). |
47+
|----------------|------------------------------------------|-----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
48+
| Latest release | For production use | [Manifests](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.3.0/deploy). | [Documentation](https://docs.nginx.com/nginx-gateway-fabric). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.3.0/examples). |
4949
| 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). |
5050

5151
### Versioning
@@ -65,8 +65,9 @@ the [Issue Lifecycle](ISSUE_LIFECYCLE.md) document for information on issue crea
6565
The following table lists the software versions NGINX Gateway Fabric supports.
6666

6767
| NGINX Gateway Fabric | Gateway API | Kubernetes | NGINX OSS | NGINX Plus |
68-
| -------------------- | ----------- | ---------- | --------- | ---------- |
68+
|----------------------|-------------|------------|-----------|------------|
6969
| Edge | 1.1.0 | 1.25+ | 1.27.0 | R32 |
70+
| 1.3.0 | 1.1.0 | 1.25+ | 1.27.0 | R32 |
7071
| 1.2.0 | 1.0.0 | 1.23+ | 1.25.4 | R31 |
7172
| 1.1.0 | 1.0.0 | 1.23+ | 1.25.3 | n/a |
7273
| 1.0.0 | 0.8.1 | 1.23+ | 1.25.2 | n/a |

‎charts/nginx-gateway-fabric/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
name: nginx-gateway-fabric
33
description: NGINX Gateway Fabric
44
type: application
5-
version: 1.2.0
5+
version: 1.3.0
66
appVersion: "edge"
77
kubeVersion: ">= 1.25.0-0"
88
home: https://github.com/nginxinc/nginx-gateway-fabric

‎charts/nginx-gateway-fabric/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# NGINX Gateway Fabric Helm Chart
33

4-
![Version: 1.2.0](https://img.shields.io/badge/Version-1.2.0-informational?style=flat-square) ![AppVersion: edge](https://img.shields.io/badge/AppVersion-edge-informational?style=flat-square)
4+
![Version: 1.3.0](https://img.shields.io/badge/Version-1.3.0-informational?style=flat-square) ![AppVersion: edge](https://img.shields.io/badge/AppVersion-edge-informational?style=flat-square)
55

66
- [NGINX Gateway Fabric Helm Chart](#nginx-gateway-fabric-helm-chart)
77
- [Introduction](#introduction)

‎docs/developer/release-process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ To create a new release, follow these steps:
5454
1. [README](/README.md) to include the information about the latest release.
5555
2. [changelog](/CHANGELOG.md).
5656
3. Helm chart `version` field.
57-
4. `VERSION` in top-level Makefile.
57+
4. `GW_API_PREV_VERSION` in tests Makefile, if necessary.
5858
5. Any references in the docs to the previous release.
5959
6. Any installation instructions to ensure that the supported Gateway API and NGF versions are correct. Specifically, helm README.
6060
11. Ask the docs team to update the production branch for NGF in Netlify to our latest release branch and run the deployment pipeline.

‎site/content/how-to/maintenance/upgrade-apps-without-downtime.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ For example, an application can be exposed using a routing rule like below:
5757
port: 80
5858
```
5959
60-
{{< note >}}See the [Cafe example](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.2.0/examples/cafe-example) for a basic example.{{< /note >}}
60+
{{< note >}}See the [Cafe example](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.3.0/examples/cafe-example) for a basic example.{{< /note >}}
6161
6262
The upgrade methods in the next sections cover:
6363
@@ -122,4 +122,4 @@ By updating the rule you can further increase the share of traffic the new versi
122122
weight: 1
123123
```
124124

125-
See the [Traffic splitting example](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.2.0/examples/traffic-splitting) from our repository.
125+
See the [Traffic splitting example](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.3.0/examples/traffic-splitting) from our repository.

‎site/content/how-to/traffic-management/advanced-routing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The goal is to create a set of rules that will result in client requests being s
3434
Begin by deploying the `coffee-v1` and `coffee-v2` applications:
3535

3636
```shell
37-
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.2.0/examples/advanced-routing/coffee.yaml
37+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.3.0/examples/advanced-routing/coffee.yaml
3838
```
3939

4040
### 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
154154
### Deploy the Tea Applications
155155

156156
```shell
157-
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.2.0/examples/advanced-routing/tea.yaml
157+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.3.0/examples/advanced-routing/tea.yaml
158158
```
159159

160160
### Deploy the HTTPRoute for the Tea Services

‎site/content/includes/installation/install-gateway-api-resources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
docs: "DOCS-1438"
33
---
44

5-
{{<note>}}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/v1.2.0/README.md#technical-specifications).{{</note>}}
5+
{{<note>}}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/v1.3.0/README.md#technical-specifications).{{</note>}}
66

77
To install the Gateway API resources, run the following:
88

99
```shell
10-
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/standard?ref=v1.2.0" | kubectl apply -f -
10+
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/standard?ref=v1.3.0" | kubectl apply -f -
1111
```
1212

1313
{{<note>}}If you plan to use the `edge` version of NGINX Gateway Fabric, you can replace the version in `ref` with `main`, for example `ref=main`.{{</note>}}
@@ -16,5 +16,5 @@ Alternatively, you can install the Gateway API resources from the experimental c
1616
additional features provided by the experimental channel. To install from the experimental channel, run the following:
1717

1818
```shell
19-
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/experimental?ref=v1.2.0" | kubectl apply -f -
19+
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/experimental?ref=v1.3.0" | kubectl apply -f -
2020
```

‎site/content/includes/installation/uninstall-gateway-api-resources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ docs: "DOCS-1436"
77
To uninstall the Gateway API resources, run the following:
88

99
```shell
10-
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/experimental?ref=v1.2.0" | kubectl delete -f -
10+
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/experimental?ref=v1.3.0" | kubectl delete -f -
1111
```
1212

1313
Alternatively, if you installed the Gateway APIs from the experimental channel, run the following:
1414

1515
```shell
16-
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/experimental?ref=v1.2.0" | kubectl delete -f -
16+
kubectl kustomize "https://github.com/nginxinc/nginx-gateway-fabric/config/crd/gateway-api/experimental?ref=v1.3.0" | kubectl delete -f -
1717
```

0 commit comments

Comments
 (0)