Skip to content

Commit ed80cd8

Browse files
committed
Update CHANGELOG and README
1 parent ed4c668 commit ed80cd8

File tree

2 files changed

+51
-31
lines changed

2 files changed

+51
-31
lines changed

CHANGELOG.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,52 +6,69 @@ and includes links to all PRs that went into the release.
66

77
## Release 2.0.0
88

9-
* Remove documentation site and GitHub Action, update README references by @ADubhlaoich in https://github.com/nginx/nginx-gateway-fabric/pull/3047
10-
* De-duplicate base headers if specified by user by @sjberman in https://github.com/nginx/nginx-gateway-fabric/pull/3249
11-
* Upgrade to NGINX Plus R34 by @sjberman in https://github.com/nginx/nginx-gateway-fabric/pull/3281
12-
* Add support for RequestMirror filter by @sjberman in https://github.com/nginx/nginx-gateway-fabric/pull/3306
13-
* Separate control plane and data plane; support multiple Gateways by @sjberman in https://github.com/nginx/nginx-gateway-fabric/pull/3318
14-
* Add fix to route parentRef internal logic by @bjee19 in https://github.com/nginx/nginx-gateway-fabric/pull/3418
9+
_June 5, 2025_
1510

16-
%%DATE%%
11+
BREAKING CHANGES:
12+
13+
[How to upgrade to 2.0.0](https://docs.nginx.com/nginx-gateway-fabric/install/upgrade-version/#upgrade-from-v1x-to-v2x).
14+
15+
The following change are breaking and require users to fully uninstall NGINX Gateway Fabric (including NGINX Gateway Fabric CRDs) before re-installing the new version. Gateway API resources (such as Gateway, HTTPRoute, etc) are unaffected and can be left alone. [3318](https://github.com/nginx/nginx-gateway-fabric/pull/3318)
16+
17+
- Control plane and data plane have been separated into different Deployments. The control plane will provision an NGINX data plane Deployment and Service when a Gateway object is created.
18+
- NginxProxy CRD resource is now namespace-scoped (was cluster-scoped).
19+
- NginxProxy resource controls infrastructure fields for the NGINX Deployment and Service, such as replicas, loadBalancerIP, serviceType, etc. Users who want to set or update these fields must do so either at installation time through the helm chart (which sets them globally), or per Gateway. Updating these fields directly on a provisioned nginx Deployment or Service will not take effect. This does not apply to the the NGINX Gateway Fabric control plane Deployment.
20+
- Helm values structure has changed slightly to better support the separate Deployments.
21+
- `nginxGateway.replicaCount` Helm value has been renamed to `nginxGateway.replicas`.
1722

1823
FEATURES:
1924

20-
-
25+
- Support for creating and deploying multiple Gateways. [3318](https://github.com/nginx/nginx-gateway-fabric/pull/3318)
26+
- NginxProxy resource can now additionally be attached to a Gateway, and will overwrite any settings that are attached at the GatewayClass level, for the Gateway that it's attached to. [3318](https://github.com/nginx/nginx-gateway-fabric/pull/3318)
27+
- Listener isolation supported for all routes. [3067](https://github.com/nginx/nginx-gateway-fabric/pull/3067)
28+
- Allow configuration of NGINX Plus API access. [3066](https://github.com/nginx/nginx-gateway-fabric/pull/3066)
29+
- Adds regex matching for headers and query params for HTTPRoutes and headers for GRPCRoutes. [3093](https://github.com/nginx/nginx-gateway-fabric/pull/3093)
30+
- Add support for request mirroring using the RequestMirror filter. [3066](https://github.com/nginx/nginx-gateway-fabric/pull/3306)
2131

2232
BUG FIXES:
2333

24-
-
34+
- Fix an issue where default headers were still being set when overwritten by a user. [3249](https://github.com/nginx/nginx-gateway-fabric/pull/3249)
35+
- Add 503 status code when there are zero upstream endpoints. [3406](https://github.com/nginx/nginx-gateway-fabric/pull/3406)
36+
- Fixed bug that occurred when a route's ParentRef does not include a sectionName and the Gateway's listeners have duplicate hostnames. This would cause conflicts when the route tries to attach to all the listeners and falsely trigger validation checks around overlapping routes. [3418](https://github.com/nginx/nginx-gateway-fabric/pull/3418)
2537

2638
DOCUMENTATION:
2739

28-
-
40+
- Migrated the documentation website into the [NGINX documentation repository](https://github.com/nginx/documentation). [3047](https://github.com/nginx/nginx-gateway-fabric/pull/3047)
2941

3042
HELM CHART:
3143

3244
- The version of the Helm chart is now 2.0.0
33-
-
45+
- Helm values structure has changed slightly to better support the separate Deployments.
46+
- `nginxGateway.replicaCount` Helm value has been renamed to `nginxGateway.replicas`.
47+
- Add support for control plane Deployment labels. [3194](https://github.com/nginx/nginx-gateway-fabric/pull/3194). Thanks to [Butterneck](https://github.com/Butterneck).
3448

3549
UPGRADE:
3650

37-
-
51+
- [Upgrade to 2.0.0](https://docs.nginx.com/nginx-gateway-fabric/install/upgrade-version/#upgrade-from-v1x-to-v2x)
3852

39-
KNOWN ISSUES:
53+
DEPENDENCIES:
4054

41-
-
55+
- NGINX Plus was updated to R34. [3281](https://github.com/nginx/nginx-gateway-fabric/pull/3281)
56+
- Update to v1.3.0 of the Gateway API. [3348](https://github.com/nginx/nginx-gateway-fabric/pull/3348)
4257

4358
COMPATIBILITY:
4459

45-
- Gateway API version: ``
46-
- NGINX version: ``
47-
- NGINX Plus version: ``
48-
- Kubernetes version: ``
60+
- Gateway API version: `1.3.0`
61+
- NGINX version: `1.28.0`
62+
- NGINX Plus version: `R24`
63+
- NGINX Agent version: `v3.0.0`
64+
- Kubernetes version: `1.25+`
4965

5066
CONTAINER IMAGES:
5167

5268
- Control plane: `ghcr.io/nginx/nginx-gateway-fabric:2.0.0`
5369
- Data plane: `ghcr.io/nginx/nginx-gateway-fabric/nginx:2.0.0`
5470
- Data plane with NGINX Plus: `private-registry.nginx.com/nginx-gateway-fabric/nginx-plus:2.0.0`
71+
5572
## Release 1.6.2
5673

5774
_March 11, 2025_

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ the [Gateway API Compatibility](https://docs.nginx.com/nginx-gateway-fabric/over
2020

2121
Learn about our [design principles](/docs/developer/design-principles.md) and [architecture](https://docs.nginx.com/nginx-gateway-fabric/overview/gateway-architecture/).
2222

23+
NGINX Gateway Fabric uses [NGINX Agent](https://github.com/nginx/agent) to configure NGINX.
24+
2325
## Getting Started
2426

2527
1. [Get started using a kind cluster](https://docs.nginx.com/nginx-gateway-fabric/get-started/).
@@ -64,19 +66,20 @@ the [Issue Lifecycle](ISSUE_LIFECYCLE.md) document for information on issue crea
6466

6567
The following table lists the software versions NGINX Gateway Fabric supports.
6668

67-
| NGINX Gateway Fabric | Gateway API | Kubernetes | NGINX OSS | NGINX Plus |
68-
|----------------------|-------------|------------|-----------|------------|
69-
| Edge | 1.3.0 | 1.25+ | 1.28.0 | R34 |
70-
| 1.6.2 | 1.2.1 | 1.25+ | 1.27.4 | R33 |
71-
| 1.6.1 | 1.2.1 | 1.25+ | 1.27.4 | R33 |
72-
| 1.6.0 | 1.2.1 | 1.25+ | 1.27.3 | R33 |
73-
| 1.5.1 | 1.2.0 | 1.25+ | 1.27.2 | R33 |
74-
| 1.5.0 | 1.2.0 | 1.25+ | 1.27.2 | R33 |
75-
| 1.4.0 | 1.1.0 | 1.25+ | 1.27.1 | R32 |
76-
| 1.3.0 | 1.1.0 | 1.25+ | 1.27.0 | R32 |
77-
| 1.2.0 | 1.0.0 | 1.23+ | 1.25.4 | R31 |
78-
| 1.1.0 | 1.0.0 | 1.23+ | 1.25.3 | n/a |
79-
| 1.0.0 | 0.8.1 | 1.23+ | 1.25.2 | n/a |
69+
| NGINX Gateway Fabric | Gateway API | Kubernetes | NGINX OSS | NGINX Plus | NGINX Agent |
70+
|----------------------|-------------|------------|-----------|------------|-------------|
71+
| Edge | 1.3.0 | 1.25+ | 1.28.0 | R34 | v3.0.0 |
72+
| 2.0.0 | 1.3.0 | 1.25+ | 1.28.0 | R34 | v3.0.0 |
73+
| 1.6.2 | 1.2.1 | 1.25+ | 1.27.4 | R33 | --- |
74+
| 1.6.1 | 1.2.1 | 1.25+ | 1.27.4 | R33 | --- |
75+
| 1.6.0 | 1.2.1 | 1.25+ | 1.27.3 | R33 | --- |
76+
| 1.5.1 | 1.2.0 | 1.25+ | 1.27.2 | R33 | --- |
77+
| 1.5.0 | 1.2.0 | 1.25+ | 1.27.2 | R33 | --- |
78+
| 1.4.0 | 1.1.0 | 1.25+ | 1.27.1 | R32 | --- |
79+
| 1.3.0 | 1.1.0 | 1.25+ | 1.27.0 | R32 | --- |
80+
| 1.2.0 | 1.0.0 | 1.23+ | 1.25.4 | R31 | --- |
81+
| 1.1.0 | 1.0.0 | 1.23+ | 1.25.3 | n/a | --- |
82+
| 1.0.0 | 0.8.1 | 1.23+ | 1.25.2 | n/a | --- |
8083

8184
## SBOM (Software Bill of Materials)
8285

0 commit comments

Comments
 (0)