You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+57-10
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,53 @@ This document includes a curated changelog for each release. We also publish a c
4
4
a [GitHub release](https://github.com/nginxinc/nginx-gateway-fabric/releases), which, by contrast, is auto-generated
5
5
and includes links to all PRs that went into the release.
6
6
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)
- 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).
- 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
+
7
54
## Release 1.3.0
8
55
9
56
_June 11, 2024_
@@ -63,7 +110,7 @@ KNOWN ISSUES:
63
110
64
111
COMPATIBILITY:
65
112
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.
67
114
- NGINX version: `1.27.0`
68
115
- NGINX Plus version: `R32`
69
116
- Kubernetes version: `1.25+`
@@ -116,7 +163,7 @@ KNOWN ISSUES:
116
163
117
164
COMPATIBILITY:
118
165
119
-
-The Gateway API version: `1.0.0`
166
+
- Gateway API version: `1.0.0`
120
167
- NGINX version: `1.25.4`
121
168
- NGINX Plus version: `R31`
122
169
- Kubernetes version: `1.23+`
@@ -165,7 +212,7 @@ UPGRADE:
165
212
166
213
COMPATIBILITY:
167
214
168
-
-The Gateway API version: `1.0.0`
215
+
- Gateway API version: `1.0.0`
169
216
- NGINX version: `1.25.3`
170
217
- Kubernetes version: `1.23+`
171
218
@@ -206,7 +253,7 @@ DOCUMENTATION:
206
253
207
254
COMPATIBILITY:
208
255
209
-
-The Gateway API version: `0.8.1`
256
+
- Gateway API version: `0.8.1`
210
257
- NGINX version: `1.25.2`
211
258
- Kubernetes version: `1.23+`
212
259
@@ -239,7 +286,7 @@ DOCUMENTATION:
239
286
240
287
COMPATIBILITY:
241
288
242
-
-The Gateway API version: `0.8.0`
289
+
- Gateway API version: `0.8.0`
243
290
- NGINX version: `1.25.2`
244
291
- Kubernetes version: `1.23+`
245
292
@@ -268,7 +315,7 @@ BUG FIXES:
268
315
269
316
COMPATIBILITY:
270
317
271
-
-The Gateway API version: `0.7.1`
318
+
- Gateway API version: `0.7.1`
272
319
- NGINX version: `1.25.x`\*
273
320
- Kubernetes version: `1.21+`
274
321
@@ -327,7 +374,7 @@ DEPENDENCIES:
327
374
328
375
COMPATIBILITY:
329
376
330
-
-The Gateway API version: `0.7.1`
377
+
- Gateway API version: `0.7.1`
331
378
- NGINX version: `1.25.x`\*
332
379
- Kubernetes version: `1.21+`
333
380
@@ -373,7 +420,7 @@ DEPENDENCIES:
373
420
374
421
COMPATIBILITY:
375
422
376
-
-The Gateway API version: `0.6.2`
423
+
- Gateway API version: `0.6.2`
377
424
- NGINX version: `1.23.x`\*
378
425
- Kubernetes version: `1.21+`
379
426
@@ -411,7 +458,7 @@ DEPENDENCIES:
411
458
412
459
COMPATIBILITY:
413
460
414
-
-The Gateway API version: `0.5.1`
461
+
- Gateway API version: `0.5.1`
415
462
- NGINX version: `1.21.x`\*
416
463
- Kubernetes version: `1.21+`
417
464
@@ -448,7 +495,7 @@ the [README](https://github.com/nginxinc/nginx-gateway-fabric) to learn how.
| 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). |
49
49
| 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). |
50
50
51
51
### Versioning
@@ -67,6 +67,7 @@ The following table lists the software versions NGINX Gateway Fabric supports.
67
67
| NGINX Gateway Fabric | Gateway API | Kubernetes | NGINX OSS | NGINX Plus |
Copy file name to clipboardExpand all lines: docs/developer/release-process.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -41,10 +41,10 @@ To create a new release, follow these steps:
41
41
2. Stop merging any new work into the main branch.
42
42
3. Create a release branch following the `release-X.Y` naming convention.
43
43
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).
46
46
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).
48
48
2. Update the [README](/README.md) to include information about the release.
49
49
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.
50
50
- 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:
66
66
4.`GW_API_PREV_VERSION` in tests Makefile, if necessary.
67
67
5. Any references in the docs to the previous release.
68
68
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**.
70
70
9. Close the issue created in Step 1.
71
71
10. Ensure that the [associated milestone](https://github.com/nginxinc/nginx-gateway-fabric/milestones) is closed.
72
72
11. Verify that published artifacts in the release can be installed properly.
Copy file name to clipboardExpand all lines: site/content/how-to/monitoring/prometheus.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -102,11 +102,11 @@ You can configure monitoring metrics for NGINX Gateway Fabric using Helm or Mani
102
102
103
103
### Using Helm
104
104
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).
106
106
107
107
### Using Kubernetes manifests
108
108
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.
Copy file name to clipboardExpand all lines: site/content/how-to/monitoring/troubleshooting.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -452,7 +452,7 @@ If you `describe` your Policy and see the following error:
452
452
453
453
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:
454
454
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.
456
456
- If the Policy allows it, specify both Routes in the `targetRefs` list.
Copy file name to clipboardExpand all lines: site/content/how-to/upgrade-apps-without-downtime.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ For example, an application can be exposed using a routing rule like below:
56
56
port: 80
57
57
```
58
58
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 >}}
60
60
61
61
The upgrade methods in the next sections cover:
62
62
@@ -121,4 +121,4 @@ By updating the rule you can further increase the share of traffic the new versi
121
121
weight: 1
122
122
```
123
123
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