Skip to content

Commit b1906e9

Browse files
committed
Update release version and process doc
1 parent 9a2c91b commit b1906e9

20 files changed

+114
-66
lines changed

.github/CHANGELOG_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ KNOWN ISSUES:
2929

3030
COMPATIBILITY:
3131

32-
- The Gateway API version: ``
32+
- Gateway API version: ``
3333
- NGINX version: ``
3434
- NGINX Plus version: ``
3535
- Kubernetes version: ``

CHANGELOG.md

+57-10
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,53 @@ 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.4.0
8+
9+
_August 20, 2024_
10+
11+
FEATURES:
12+
13+
- Support IPv6. [2190](https://github.com/nginxinc/nginx-gateway-fabric/pull/2190)
14+
- Add support for TLS Passthrough using TLSRoutes. [2356](https://github.com/nginxinc/nginx-gateway-fabric/pull/2356)
15+
- Support cross-namespace routing with TLSRoutes. [2379](https://github.com/nginxinc/nginx-gateway-fabric/pull/2379)
16+
- Added server_zone metrics for NGINX Plus users. [2360](https://github.com/nginxinc/nginx-gateway-fabric/pull/2360)
17+
18+
BUG FIXES:
19+
20+
- Fixed issue where NGF Pod cannot recover if NGINX master process fails without cleaning up. [2131](https://github.com/nginxinc/nginx-gateway-fabric/pull/2131)
21+
- Leader election couldn't be disabled. [2307](https://github.com/nginxinc/nginx-gateway-fabric/pull/2307)
22+
- Disallow routes from attaching to listeners if not present in allowed routes. [2314](https://github.com/nginxinc/nginx-gateway-fabric/pull/2314)
23+
- Honor ReferenceGrants that allow GRPCRoutes to reference Services in different namespaces. [2337](https://github.com/nginxinc/nginx-gateway-fabric/pull/2337)
24+
- Fixed an issue that prevented ClientSettingsPolicies and ObservabilityPolicies from working when attached to an HTTPRoute where matching conditions were defined. [2318](https://github.com/nginxinc/nginx-gateway-fabric/pull/2318)
25+
- Replace TODO route condition with an Accepted/False condition. [2228](https://github.com/nginxinc/nginx-gateway-fabric/pull/2228)
26+
27+
DOCUMENTATION:
28+
29+
- Enhanced the troubleshooting guide with more details and scenarios. [2141](https://github.com/nginxinc/nginx-gateway-fabric/pull/2141)
30+
- Update kubectl exec syntax to remove deprecation warning. [2218](https://github.com/nginxinc/nginx-gateway-fabric/pull/2218). Thanks [aknot242](https://github.com/aknot242).
31+
- Add info on setting up host network access. [2263](https://github.com/nginxinc/nginx-gateway-fabric/pull/2263). Thanks [fardarter](https://github.com/fardarter).
32+
33+
HELM CHART:
34+
35+
- The version of the Helm chart is now 1.4.0
36+
- Add capability to set resource requests and limits on nginx-gateway deployment. [2216](https://github.com/nginxinc/nginx-gateway-fabric/pull/2216). Thanks to [anwbtom](https://github.com/anwbtom).
37+
- Add capability to configure custom annotations for the nginx-gateway-fabric pod(s). [2250](https://github.com/nginxinc/nginx-gateway-fabric/pull/2250). Thanks to [Robsta86](https://github.com/Robsta86).
38+
- Add helm chart examples. [2292](https://github.com/nginxinc/nginx-gateway-fabric/pull/2292)
39+
- Add seccompProfile. [2323](https://github.com/nginxinc/nginx-gateway-fabric/pull/2323)
40+
41+
COMPATIBILITY:
42+
43+
- Gateway API version: `1.1.0`
44+
- NGINX version: `1.27.1`
45+
- NGINX Plus version: `R32`
46+
- Kubernetes version: `1.25+`
47+
48+
CONTAINER IMAGES:
49+
50+
- Control plane: `ghcr.io/nginxinc/nginx-gateway-fabric:1.4.0`
51+
- Data plane: `ghcr.io/nginxinc/nginx-gateway-fabric/nginx:1.4.0`
52+
- Data plane with NGINX Plus: `private-registry.nginx.com/nginx-gateway-fabric/nginx-plus:1.4.0`
53+
754
## Release 1.3.0
855

956
_June 11, 2024_
@@ -63,7 +110,7 @@ KNOWN ISSUES:
63110

64111
COMPATIBILITY:
65112

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.
113+
- 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.
67114
- NGINX version: `1.27.0`
68115
- NGINX Plus version: `R32`
69116
- Kubernetes version: `1.25+`
@@ -116,7 +163,7 @@ KNOWN ISSUES:
116163

117164
COMPATIBILITY:
118165

119-
- The Gateway API version: `1.0.0`
166+
- Gateway API version: `1.0.0`
120167
- NGINX version: `1.25.4`
121168
- NGINX Plus version: `R31`
122169
- Kubernetes version: `1.23+`
@@ -165,7 +212,7 @@ UPGRADE:
165212

166213
COMPATIBILITY:
167214

168-
- The Gateway API version: `1.0.0`
215+
- Gateway API version: `1.0.0`
169216
- NGINX version: `1.25.3`
170217
- Kubernetes version: `1.23+`
171218

@@ -206,7 +253,7 @@ DOCUMENTATION:
206253

207254
COMPATIBILITY:
208255

209-
- The Gateway API version: `0.8.1`
256+
- Gateway API version: `0.8.1`
210257
- NGINX version: `1.25.2`
211258
- Kubernetes version: `1.23+`
212259

@@ -239,7 +286,7 @@ DOCUMENTATION:
239286

240287
COMPATIBILITY:
241288

242-
- The Gateway API version: `0.8.0`
289+
- Gateway API version: `0.8.0`
243290
- NGINX version: `1.25.2`
244291
- Kubernetes version: `1.23+`
245292

@@ -268,7 +315,7 @@ BUG FIXES:
268315

269316
COMPATIBILITY:
270317

271-
- The Gateway API version: `0.7.1`
318+
- Gateway API version: `0.7.1`
272319
- NGINX version: `1.25.x` \*
273320
- Kubernetes version: `1.21+`
274321

@@ -327,7 +374,7 @@ DEPENDENCIES:
327374

328375
COMPATIBILITY:
329376

330-
- The Gateway API version: `0.7.1`
377+
- Gateway API version: `0.7.1`
331378
- NGINX version: `1.25.x` \*
332379
- Kubernetes version: `1.21+`
333380

@@ -373,7 +420,7 @@ DEPENDENCIES:
373420

374421
COMPATIBILITY:
375422

376-
- The Gateway API version: `0.6.2`
423+
- Gateway API version: `0.6.2`
377424
- NGINX version: `1.23.x` \*
378425
- Kubernetes version: `1.21+`
379426

@@ -411,7 +458,7 @@ DEPENDENCIES:
411458

412459
COMPATIBILITY:
413460

414-
- The Gateway API version: `0.5.1`
461+
- Gateway API version: `0.5.1`
415462
- NGINX version: `1.21.x` \*
416463
- Kubernetes version: `1.21+`
417464

@@ -448,7 +495,7 @@ the [README](https://github.com/nginxinc/nginx-gateway-fabric) to learn how.
448495

449496
COMPATIBILITY:
450497

451-
- The Gateway API version: `0.5.0`
498+
- Gateway API version: `0.5.0`
452499
- NGINX version: `1.21.3`
453500
- Kubernetes version: `1.19+`
454501

README.md

+3-2
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.3.0](https://github.com/nginxinc/nginx-gateway-fabric/releases/tag/v1.3.0).
37+
The latest release is [1.4.0](https://github.com/nginxinc/nginx-gateway-fabric/releases/tag/v1.4.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)
@@ -45,7 +45,7 @@ to the correct versions:
4545

4646
| Version | Description | Installation Manifests | Documentation and Examples |
4747
|----------------|------------------------------------------|-----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
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). |
48+
| 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). |
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
@@ -67,6 +67,7 @@ The following table lists the software versions NGINX Gateway Fabric supports.
6767
| NGINX Gateway Fabric | Gateway API | Kubernetes | NGINX OSS | NGINX Plus |
6868
|----------------------|-------------|------------|-----------|------------|
6969
| Edge | 1.1.0 | 1.25+ | 1.27.1 | R32 |
70+
| 1.4.0 | 1.1.0 | 1.25+ | 1.27.1 | R32 |
7071
| 1.3.0 | 1.1.0 | 1.25+ | 1.27.0 | R32 |
7172
| 1.2.0 | 1.0.0 | 1.23+ | 1.25.4 | R31 |
7273
| 1.1.0 | 1.0.0 | 1.23+ | 1.25.3 | n/a |

charts/nginx-gateway-fabric/Chart.yaml

+1-1
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.3.0
5+
version: 1.4.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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# NGINX Gateway Fabric Helm Chart
33

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)
4+
![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)
55

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

docs/developer/release-process.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ To create a new release, follow these steps:
4141
2. Stop merging any new work into the main branch.
4242
3. Create a release branch following the `release-X.Y` naming convention.
4343
4. Once the release branch pipeline completes, run tests using the `release-X.X-rc` images that are pushed to Github (for example, `release-1.3-rc`).
44-
1. Kick off the [NFR workflow](https://github.com/nginxinc/nginx-gateway-fabric/actions/workflows/nfr.yml) in the browser. For `image_tag`, use `release-X.X-rc`, and for `version`, use the upcoming `X.Y.Z` NGF version. This will run all of the NFR tests which are automated and open a PR with the results files when it is complete. Review this PR and make any necessary changes before merging.
45-
2. Run the [examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/examples) using the release images and verify their correctness.
44+
1. Kick off the [longevity tests](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/tests/README.md#longevity-testing) for both OSS and Plus. You'll need to create two clusters and VMs for this. Before running, update your `vars.env` file with the proper image tag and prefixes. NGF and nginx images will be available from `ghcr.io`, and nginx plus will be available in GCP (`us-docker.pkg.dev/<GCP_PROJECT_ID>/nginx-gateway-fabric/nginx-plus`). These tests need to run for 4 days before releasing. The results should be committed to the main branch and then cherry-picked to the release branch.
45+
2. Kick off the [NFR workflow](https://github.com/nginxinc/nginx-gateway-fabric/actions/workflows/nfr.yml) in the browser. For `image_tag`, use `release-X.X-rc`, and for `version`, use the upcoming `X.Y.Z` NGF version. This will run all of the NFR tests which are automated and open a PR with the results files when it is complete. Review this PR and make any necessary changes before merging. Once merged, be sure to cherry-pick the commit to the main branch as well (the original PR targets the release branch).
4646
5. Run the [Release PR](https://github.com/nginxinc/nginx-gateway-fabric/actions/workflows/release-pr.yml) workflow to update the repo files for the release. Then there are a few manual steps to complete:
47-
1. Update the tag of NGF container images used in the [provisioner manifest](/tests/conformance/provisioner/provisioner.yaml).
47+
1. Update the tag of NGF container images used in the [provisioner manifest](/tests/conformance/provisioner/provisioner.yaml) and [running-on-kind guide](/site/content/installation/running-on-kind.md#set-up-a-nodeport).
4848
2. Update the [README](/README.md) to include information about the release.
4949
3. Update the [changelog](/CHANGELOG.md). There is going to be a new blank section generated by the automation that needs to be adjusted accordingly.
5050
- At the top there will be a list of all PRs that are labeled with `release-notes`.
@@ -66,7 +66,7 @@ To create a new release, follow these steps:
6666
4. `GW_API_PREV_VERSION` in tests Makefile, if necessary.
6767
5. Any references in the docs to the previous release.
6868
6. Any installation instructions to ensure that the supported Gateway API and NGF versions are correct. Specifically, helm README.
69-
8. Ask the docs team to update the production branch for NGF in Netlify to our latest release branch and run the deployment pipeline.
69+
8. Run the [docs workflow](https://github.com/nginxinc/nginx-gateway-fabric/actions/workflows/docs-build-push.yml) for the **release branch**.
7070
9. Close the issue created in Step 1.
7171
10. Ensure that the [associated milestone](https://github.com/nginxinc/nginx-gateway-fabric/milestones) is closed.
7272
11. Verify that published artifacts in the release can be installed properly.

site/content/how-to/monitoring/prometheus.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,11 @@ You can configure monitoring metrics for NGINX Gateway Fabric using Helm or Mani
102102

103103
### Using Helm
104104

105-
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.3.0/charts/nginx-gateway-fabric/README.md).
105+
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).
106106

107107
### Using Kubernetes manifests
108108

109-
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.3.0/deploy) directory.
109+
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.
110110

111111
#### Disabling metrics
112112

site/content/how-to/monitoring/troubleshooting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ If you `describe` your Policy and see the following error:
452452
453453
This means you are attempting to attach a Policy to a Route that has an overlapping hostname:port/path combination with another Route. To work around this, you can do one of the following:
454454
455-
- Combine the Route rules for the overlapping path into a single route.
455+
- Combine the Route rules for the overlapping path into a single Route.
456456
- If the Policy allows it, specify both Routes in the `targetRefs` list.
457457
458458
### Further reading

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The goal is to create a set of rules that will result in client requests being s
3636
Begin by deploying the `coffee-v1` and `coffee-v2` applications:
3737

3838
```shell
39-
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.3.0/examples/advanced-routing/coffee.yaml
39+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.4.0/examples/advanced-routing/coffee.yaml
4040
```
4141

4242
### 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
156156
### Deploy the Tea applications
157157

158158
```shell
159-
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.3.0/examples/advanced-routing/tea.yaml
159+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.4.0/examples/advanced-routing/tea.yaml
160160
```
161161

162162
### Deploy the HTTPRoute for the Tea services

site/content/how-to/traffic-management/client-settings.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,19 @@ For all the possible configuration options for `ClientSettingsPolicy`, see the [
4545
- Create the coffee and tea example applications:
4646

4747
```yaml
48-
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.3.0/examples/client-settings-policy/app.yaml
48+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.4.0/examples/client-settings-policy/app.yaml
4949
```
5050

5151
- Create a Gateway:
5252

5353
```yaml
54-
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.3.0/examples/client-settings-policy/gateway.yaml
54+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.4.0/examples/client-settings-policy/gateway.yaml
5555
```
5656

5757
- Create HTTPRoutes for the coffee and tea applications:
5858

5959
```yaml
60-
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.3.0/examples/client-settings-policy/httproutes.yaml
60+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.4.0/examples/client-settings-policy/httproutes.yaml
6161
```
6262

6363
- Test the configuration:

site/content/how-to/traffic-management/response-headers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ We'll begin by configuring an app with custom headers and a straightforward HTTP
3131
Begin by deploying the example application `headers`. It is a simple application that adds response headers which we'll later tweak and customize.
3232

3333
```shell
34-
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.3.0/examples/http-response-header-filter/headers.yaml
34+
kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/v1.4.0/examples/http-response-header-filter/headers.yaml
3535
```
3636

3737
This will create the headers Service and a Deployment with one Pod. Run the following command to verify the resources were created:

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

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

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

0 commit comments

Comments
 (0)