Skip to content

Commit a5eec37

Browse files
sjbermansjberman
authored
Release 2.0 docs (#3466)
Added CHANGELOG and updated README and other version strings and docs links for the 2.0.0 release.
1 parent 1ff9e7a commit a5eec37

File tree

20 files changed

+105
-37
lines changed

20 files changed

+105
-37
lines changed

‎CHANGELOG.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,71 @@ This document includes a curated changelog for each release. We also publish a c
44
a [GitHub release](https://github.com/nginx/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 2.0.0
8+
9+
_June 5, 2025_
10+
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 changes 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`.
22+
23+
FEATURES:
24+
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)
31+
32+
BUG FIXES:
33+
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)
37+
38+
DOCUMENTATION:
39+
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)
41+
42+
HELM CHART:
43+
44+
- The version of the Helm chart is now 2.0.0
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).
48+
49+
UPGRADE:
50+
51+
- [Upgrade to 2.0.0](https://docs.nginx.com/nginx-gateway-fabric/install/upgrade-version/#upgrade-from-v1x-to-v2x)
52+
53+
DEPENDENCIES:
54+
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)
57+
58+
COMPATIBILITY:
59+
60+
- Gateway API version: `1.3.0`
61+
- NGINX version: `1.28.0`
62+
- NGINX Plus version: `R34`
63+
- NGINX Agent version: `v3.0.0`
64+
- Kubernetes version: `1.25+`
65+
66+
CONTAINER IMAGES:
67+
68+
- Control plane: `ghcr.io/nginx/nginx-gateway-fabric:2.0.0`
69+
- Data plane: `ghcr.io/nginx/nginx-gateway-fabric/nginx:2.0.0`
70+
- Data plane with NGINX Plus: `private-registry.nginx.com/nginx-gateway-fabric/nginx-plus:2.0.0`
71+
772
## Release 1.6.2
873

974
_March 11, 2025_

‎CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Reserve GitHub issues for feature requests and bugs rather than general question
3232

3333
## Getting Started
3434

35-
Follow our [Installation Instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to get the NGINX Gateway Fabric up and running.
35+
Follow our [Installation Instructions](https://docs.nginx.com/nginx-gateway-fabric/install/) to get the NGINX Gateway Fabric up and running.
3636

3737
### Project Structure
3838

‎README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@ 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/).
26-
2. [Install](https://docs.nginx.com/nginx-gateway-fabric/installation/) NGINX Gateway Fabric.
28+
2. [Install](https://docs.nginx.com/nginx-gateway-fabric/install/) NGINX Gateway Fabric.
2729
3. Deploy various [examples](examples).
28-
4. Read our [How-to guides](https://docs.nginx.com/nginx-gateway-fabric/how-to/).
30+
4. Follow instructions for common use cases such as [routing](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/) and [securing](https://docs.nginx.com/nginx-gateway-fabric/traffic-security/) traffic, or [monitoring](https://docs.nginx.com/nginx-gateway-fabric//monitoring/) your cluster.
2931

3032
You can find the comprehensive NGINX Gateway Fabric user documentation on the [NGINX Documentation](https://docs.nginx.com/nginx-gateway-fabric/) website.
3133

@@ -34,7 +36,7 @@ You can find the comprehensive NGINX Gateway Fabric user documentation on the [N
3436
We publish NGINX Gateway Fabric releases on GitHub. See
3537
our [releases page](https://github.com/nginx/nginx-gateway-fabric/releases).
3638

37-
The latest release is [1.6.2](https://github.com/nginx/nginx-gateway-fabric/releases/tag/v1.6.2).
39+
The latest release is [2.0.0](https://github.com/nginx/nginx-gateway-fabric/releases/tag/v2.0.0).
3840

3941
The edge version is useful for experimenting with new features that are not yet published in a release. To use, choose
4042
the _edge_ version built from the [latest commit](https://github.com/nginx/nginx-gateway-fabric/commits/main)
@@ -45,7 +47,7 @@ to the correct versions:
4547

4648
| Version | Description | Installation Manifests | Documentation and Examples |
4749
|----------------|------------------------------------------|--------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
48-
| Latest release | For production use | [Manifests](https://github.com/nginx/nginx-gateway-fabric/tree/v1.6.2/deploy). | [Documentation](https://docs.nginx.com/nginx-gateway-fabric). [Examples](https://github.com/nginx/nginx-gateway-fabric/tree/v1.6.2/examples). |
50+
| Latest release | For production use | [Manifests](https://github.com/nginx/nginx-gateway-fabric/tree/v2.0.0/deploy). | [Documentation](https://docs.nginx.com/nginx-gateway-fabric). [Examples](https://github.com/nginx/nginx-gateway-fabric/tree/v2.0.0/examples). |
4951
| Edge | For experimental use and latest features | [Manifests](https://github.com/nginx/nginx-gateway-fabric/tree/main/deploy). | [Examples](https://github.com/nginx/nginx-gateway-fabric/tree/main/examples). |
5052

5153
### Versioning
@@ -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

@@ -103,7 +106,7 @@ docker buildx imagetools inspect ghcr.io/nginx/nginx-gateway-fabric:edge --forma
103106

104107
## Troubleshooting
105108

106-
For troubleshooting help, see the [Troubleshooting](https://docs.nginx.com/nginx-gateway-fabric/how-to/monitoring/troubleshooting/) document.
109+
For troubleshooting help, see the [Troubleshooting](https://docs.nginx.com/nginx-gateway-fabric/troubleshooting/) document.
107110

108111
## Contacts
109112

@@ -133,4 +136,4 @@ Please read our [Contributing guide](CONTRIBUTING.md) if you'd like to contribut
133136

134137
If your team needs dedicated support for NGINX Gateway Fabric in your environment, or you would like to leverage our [advanced NGINX Plus features](https://docs.nginx.com/nginx-gateway-fabric/overview/nginx-plus/), you can reach out [here](https://www.f5.com/content/f5-com/en_us/products/get-f5).
135138

136-
To try NGINX Gateway Fabric with NGINX Plus, you can start your free [30-day trial](https://www.f5.com/trials), then follow the [installation guide](https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/helm/) for installing with NGINX Plus.
139+
To try NGINX Gateway Fabric with NGINX Plus, you can start your free [30-day trial](https://www.f5.com/trials), then follow the [installation guide](https://docs.nginx.com/nginx-gateway-fabric/install/helm/) for installing with NGINX Plus.

‎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.6.2
5+
version: 2.0.0
66
appVersion: "edge"
77
kubeVersion: ">= 1.25.0-0"
88
home: https://github.com/nginx/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.6.2](https://img.shields.io/badge/Version-1.6.2-informational?style=flat-square) ![AppVersion: edge](https://img.shields.io/badge/AppVersion-edge-informational?style=flat-square)
4+
![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.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)

‎deploy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ use the following command to apply the manifests:
1212
kubectl kustomize | kubectl apply -f -
1313
```
1414

15-
For more information on how to deploy NGINX Gateway Fabric and the Gateway API CRDs see the [installation guide](https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/manifests/).
15+
For more information on how to deploy NGINX Gateway Fabric and the Gateway API CRDs see the [installation guide](https://docs.nginx.com/nginx-gateway-fabric/install/manifests/).

‎design/control-data-plane-separation/design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -713,7 +713,7 @@ have a use case for runtime configuration at the moment.
713713

714714
[agent-config]: https://github.com/nginx/agent/blob/ea3a1b4df5d7ecf95bd3d9297d26e420f5e1dd57/sdk/proto/agent.pb.go#L320
715715

716-
[cli]: https://docs.nginx.com/nginx-management-suite/nginx-agent/install-nginx-agent/#nginx-agent-cli-flags-usage
716+
[cli]: https://docs.nginx.com/nginx-agent/configuration/configuration-overview/#cli-flags--environment-variables
717717

718718
## Edge Cases
719719

‎docs/developer/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ This will build the docker images `nginx-gateway-fabric:<your-user>` and `nginx-
121121

122122
> Note: You will need a valid NGINX Plus license certificate and key named `nginx-repo.crt` and `nginx-repo.key` in the
123123
> root of this repo to build the NGINX Plus image.
124-
> You will also need a valid NGINX Plus JSON Web Token (JWT) to deploy NGF with NGINX Plus. That JWT should be stored in the `license.jwt` file in the root of the `nginx-gateway-fabric/` directory. See the [documentation](https://docs.nginx.com/nginx-gateway-fabric/installation/nginx-plus-jwt/) for instructions on how to download and set up the JWT.
124+
> You will also need a valid NGINX Plus JSON Web Token (JWT) to deploy NGF with NGINX Plus. That JWT should be stored in the `license.jwt` file in the root of the `nginx-gateway-fabric/` directory. See the [documentation](https://docs.nginx.com/nginx-gateway-fabric/install/nginx-plus/) for instructions on how to download and set up the JWT.
125125
> Additionally, you need to set the NGINX Plus usage endpoint in your environment. For development and testing, export `PLUS_USAGE_ENDPOINT=<N1 staging endpoint>`.
126126
127127
To build the NGINX Gateway Fabric and NGINX Plus container images from source run the following make command:

‎examples/advanced-routing/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Advanced Routing
22

3-
This directory contains the YAML files used in the [Advanced Routing](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/advanced-routing/) guide.
3+
This directory contains the YAML files used in the [Advanced Routing](https://docs.nginx.com/nginx-gateway-fabric/traffic-management/advanced-routing/) guide.

‎examples/cafe-example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ to route traffic to that application using HTTPRoute resources.
77

88
## 1. Deploy NGINX Gateway Fabric
99

10-
1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/installation/) to deploy NGINX Gateway Fabric.
10+
1. Follow the [installation instructions](https://docs.nginx.com/nginx-gateway-fabric/install/) to deploy NGINX Gateway Fabric.
1111

1212
## 2. Deploy the Cafe Application
1313

0 commit comments

Comments
 (0)