Skip to content

Commit a18b14d

Browse files
committed
Update documentation on main after 1.1 release (nginx#1390)
1 parent 594763e commit a18b14d

File tree

7 files changed

+57
-41
lines changed

7 files changed

+57
-41
lines changed

CHANGELOG.md

Lines changed: 47 additions & 0 deletions
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.1.0
8+
9+
*December 14, 2023*
10+
11+
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.
12+
13+
FEATURES:
14+
15+
- Update to v1.0.0 of the Gateway API. [PR-1250](https://github.com/nginxinc/nginx-gateway-fabric/pull/1250)
16+
- Set the SupportedVersion Condition on GatewayClass. [PR-1301](https://github.com/nginxinc/nginx-gateway-fabric/pull/1301)
17+
18+
BUG FIXES:
19+
20+
- Merge HTTPRoute conditions from all Gateway controllers. [PR-1220](https://github.com/nginxinc/nginx-gateway-fabric/pull/1220)
21+
- Validate header names and report validation errors in the HTTPRoute status. [PR-1239](https://github.com/nginxinc/nginx-gateway-fabric/pull/1239)
22+
- Remove usage info from log output. [PR-1242](https://github.com/nginxinc/nginx-gateway-fabric/pull/1242)
23+
- Set the Gateway Listener status AttachedRoutes field to the number of Routes associated with a Listener regardless of Gateway or Route status. [PR-1275](https://github.com/nginxinc/nginx-gateway-fabric/pull/1275)
24+
- Set file mode explicitly for regular NGINX configuration files. [PR-1323](https://github.com/nginxinc/nginx-gateway-fabric/pull/1323). Thanks to [Kai-Hsun Chen](https://github.com/kevin85421).
25+
26+
DOCUMENTATION:
27+
28+
- Documentation is now available on docs.nginx.com. [Link](https://docs.nginx.com/nginx-gateway-fabric/)
29+
- Update the resource validation documents to cover CEL validation. [Link](https://docs.nginx.com/nginx-gateway-fabric/overview/resource-validation/)
30+
- Non-functional testing results. [Link](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/tests)
31+
32+
HELM CHART:
33+
34+
- The version of the Helm chart is now 1.1.0.
35+
- Add tolerations to the helm chart. [PR-1192](https://github.com/nginxinc/nginx-gateway-fabric/pull/1192). Thanks to [Jerome Brown](https://github.com/oWretch).
36+
- Add extra volume mounts to the helm chart. [PR-1193](https://github.com/nginxinc/nginx-gateway-fabric/pull/1193). Thanks to [Jerome Brown](https://github.com/oWretch).
37+
- Fix broken helm chart icon links. [PR-1290](https://github.com/nginxinc/nginx-gateway-fabric/pull/1290). Thanks to [arukiidou](https://github.com/arukiidou).
38+
39+
UPGRADE:
40+
41+
- This version of NGINX Gateway Fabric is not compatible with v0.8.0 of the Gateway API. You must upgrade the Gateway API CRDs to v1.0.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).
42+
43+
COMPATIBILITY:
44+
45+
- The Gateway API version: `1.0.0`
46+
- NGINX version: `1.25.3`
47+
- Kubernetes version: `1.23+`
48+
49+
CONTAINER IMAGES:
50+
51+
- Control plane: `ghcr.io/nginxinc/nginx-gateway-fabric:1.1.0`
52+
- Data plane: `ghcr.io/nginxinc/nginx-gateway-fabric/nginx:1.1.0`
53+
754
## Release 1.0.0
855

956
*October 24, 2023*

README.md

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

34-
The latest release is [1.0.0](https://github.com/nginxinc/nginx-gateway-fabric/releases/tag/v1.0.0).
34+
The latest release is [1.1.0](https://github.com/nginxinc/nginx-gateway-fabric/releases/tag/v1.1.0).
3535

3636
The edge version is useful for experimenting with new features that are not yet published in a release. To use, choose
3737
the *edge* version built from the [latest commit](https://github.com/nginxinc/nginx-gateway-fabric/commits/main)
@@ -40,10 +40,10 @@ from the main branch.
4040
The table below summarizes the options regarding the images, manifests, documentation and examples and gives your links
4141
to the correct versions:
4242

43-
| Version | Description | Installation Manifests | Documentation and Examples |
44-
|----------------|------------------------------------------|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
45-
| Latest release | For production use | [Manifests](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.0.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.0.0/docs). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.0.0/examples). |
46-
| 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/docs). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/main/examples). |
43+
| Version | Description | Installation Manifests | Documentation and Examples |
44+
|----------------|------------------------------------------|-----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
45+
| Latest release | For production use | [Manifests](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/deploy). | [Documentation](https://docs.nginx.com/nginx-gateway-fabric). [Examples](https://github.com/nginxinc/nginx-gateway-fabric/tree/v1.1.0/examples). |
46+
| 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). |
4747

4848
### Versioning
4949

@@ -65,6 +65,7 @@ The following table lists the software versions NGINX Gateway Fabric supports.
6565
| NGINX Gateway Fabric | Gateway API | Kubernetes | NGINX OSS |
6666
|----------------------|-------------|------------|-----------|
6767
| Edge | 1.0.0 | 1.23+ | 1.25.3 |
68+
| 1.1.0 | 1.0.0 | 1.23+ | 1.25.3 |
6869
| 1.0.0 | 0.8.1 | 1.23+ | 1.25.2 |
6970
| 0.6.0 | 0.8.0 | 1.23+ | 1.25.2 |
7071
| 0.5.0 | 0.7.1 | 1.21+ | 1.25.x * |

deploy/helm-chart/README.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,6 @@ This chart deploys the NGINX Gateway Fabric in your Kubernetes cluster.
3737
> they are the correct version as supported by the NGINX Gateway Fabric -
3838
> [see the Technical Specifications](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/README.md#technical-specifications).
3939
40-
If installing the latest stable release of NGINX Gateway Fabric, ensure you are deploying its supported version of
41-
the Gateway API resources:
42-
43-
```shell
44-
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.8.1/standard-install.yaml
45-
```
46-
47-
If you are installing the edge version of NGINX Gateway Fabric:
48-
4940
```shell
5041
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml
5142
```

docs/developer/release-process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ To create a new release, follow these steps:
6161
10. Prepare and merge a PR into the main branch to update the [README](/README.md) to include the information about
6262
the latest release and also the [changelog](/CHANGELOG.md). Also update any installation instructions to ensure
6363
that the supported Gateway API and NGF versions are correct. Specifically, helm README and `site/content/includes/installation/install-gateway-api-resources.md`.
64-
11. Update the production branch to the latest release branch in [Netlify](https://app.netlify.com/sites/nginx-gateway-fabric/configuration/deploys#branches-and-deploy-contexts). If it's your first time, log in using Gitlab SSO and ask the docs team for permission to access the NGF project. Ensure that once the branch is updated, the deployment pipeline in Netlify passes and that the published docs look good (no obvious errors or issues).
64+
11. Update the production branch to the latest release branch in [Netlify](https://app.netlify.com/sites/nginx-gateway-fabric/configuration/deploys#branches-and-deploy-contexts). If it's your first time, log in using Gitlab SSO and ask the docs team for permission to access the NGF project. Once the branch is updated, redeploy the docs in Netlify. Verify that the Netlify deploy passes and that the published docs look good (no obvious errors or issues).
6565
12. Close the issue created in Step 1.
6666
13. Ensure that the [associated milestone](https://github.com/nginxinc/nginx-gateway-fabric/milestones) is closed.
6767
14. Verify that published artifacts in the release can be installed properly.

examples/http-header-filter/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ Headers:
7272
header 'My-cool-header' is 'my-client-value, this-is-an-appended-value'
7373
header 'My-Overwrite-Header' is 'this-is-the-only-value'
7474
header 'Host' is 'echo.example.com:$GW_PORT'
75+
header 'X-Forwarded-For' is '$GW_IP'
7576
header 'Connection' is 'close'
7677
header 'Accept' is '*/*'
7778
```

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

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,7 @@ docs:
44

55
{{<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/main/README.md#technical-specifications).{{</note>}}
66

7-
**Stable release**
8-
9-
If installing the latest stable release of NGINX Gateway Fabric, ensure you are deploying its supported version of
10-
the Gateway API resources:
11-
12-
```shell
13-
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.8.1/standard-install.yaml
14-
```
15-
16-
**Edge version**
17-
18-
If installing the edge version of NGINX Gateway Fabric from the **main** branch:
7+
To install the Gateway API resources, run the following:
198

209
```shell
2110
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml

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

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,12 @@ docs:
44

55
{{<warning>}}This will remove all corresponding custom resources in your entire cluster, across all namespaces. Double-check to make sure you don't have any custom resources you need to keep, and confirm that there are no other Gateway API implementations active in your cluster.{{</warning>}}
66

7-
To uninstall the Gateway API resources, including the CRDs and the validating webhook, run the following:
8-
9-
**Stable release**
10-
11-
If you were running the latest stable release version of NGINX Gateway Fabric:
12-
13-
```shell
14-
kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.8.1/standard-install.yaml
15-
```
16-
17-
**Edge version**
18-
19-
If you were running the edge version of NGINX Gateway Fabric from the **main** branch:
7+
To uninstall the Gateway API resources, run the following:
208

219
```shell
2210
kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.0.0/standard-install.yaml
2311
```
2412

25-
2613
If you are running on Kubernetes 1.23 or 1.24, you also need to delete the validating webhook. To do so, run:
2714

2815
```shell

0 commit comments

Comments
 (0)