Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lucacome committed Dec 16, 2024
1 parent ecee60c commit 2cbb5d4
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 29 deletions.
33 changes: 9 additions & 24 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,46 +6,31 @@ and includes links to all PRs that went into the release.

## Release 1.5.1

n
%%DATE%%

FEATURES:

-
_December 16, 2024_

BUG FIXES:

-

DOCUMENTATION:

-
- Write deployment context in init container. [2905](https://github.com/nginxinc/nginx-gateway-fabric/pull/2905)
- SnippetsFilter CRD missing from CRDs manifest. [2822](https://github.com/nginxinc/nginx-gateway-fabric/pull/2822)
- Omit empty deployment context fields. [2910](https://github.com/nginxinc/nginx-gateway-fabric/pull/2910)

HELM CHART:

- The version of the Helm chart is now 1.5.1
-

UPGRADE:

-

KNOWN ISSUES:

-

COMPATIBILITY:

- Gateway API version: ``
- NGINX version: ``
- NGINX Plus version: ``
- Kubernetes version: ``
- Gateway API version: `1.2.0`
- NGINX version: `1.27.2`
- NGINX Plus version: `R33`
- Kubernetes version: `1.25+`

CONTAINER IMAGES:

- Control plane: `ghcr.io/nginxinc/nginx-gateway-fabric:1.5.1`
- Data plane: `ghcr.io/nginxinc/nginx-gateway-fabric/nginx:1.5.1`
- Data plane with NGINX Plus: `private-registry.nginx.com/nginx-gateway-fabric/nginx-plus:1.5.1`

## Release 1.5.0

_November 20, 2024_
Expand Down
4 changes: 2 additions & 2 deletions site/content/installation/installing-ngf/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ docs: "DOCS-1430"

Learn how to install, upgrade, and uninstall NGINX Gateway Fabric in a Kubernetes cluster using Helm.

{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.1 need to install an NGINX Plus JWT
{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.x need to install an NGINX Plus JWT
Secret before upgrading. Follow the steps in the [Before you begin](#before-you-begin) section to create the Secret. If you use a different name than the default `nplus-license` name, specify the Secret name by setting `--set nginx.usage.secretName=<secret-name>` when running `helm upgrade`. {{< /important >}}

## Before you begin
Expand Down Expand Up @@ -210,7 +210,7 @@ To upgrade the CRDs, take the following steps:

### Upgrade NGINX Gateway Fabric release

{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.1 need to install an NGINX Plus JWT
{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.x need to install an NGINX Plus JWT
Secret before upgrading. Follow the steps in the [Before you begin](#before-you-begin) section to create the Secret. If you use a different name than the default `nplus-license` name, specify the Secret name by setting `--set nginx.usage.secretName=<secret-name>` when running `helm upgrade`. {{</ important >}}

There are two possible ways to upgrade NGINX Gateway Fabric. You can either upgrade from the OCI registry, or download the chart and upgrade from the source.
Expand Down
4 changes: 2 additions & 2 deletions site/content/installation/installing-ngf/manifests.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ docs: "DOCS-1429"

Learn how to install, upgrade, and uninstall NGINX Gateway Fabric using Kubernetes manifests.

{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.1 need to install an NGINX Plus JWT
{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.x need to install an NGINX Plus JWT
Secret before upgrading. Follow the steps in the [Before you begin](#before-you-begin) section to create the Secret, which is referenced in the updated deployment manifest for the newest version. {{< /important >}}

## Before you begin
Expand Down Expand Up @@ -179,7 +179,7 @@ nginx-gateway-5d4f4c7db7-xk2kq 2/2 Running 0 112s

## Upgrade NGINX Gateway Fabric

{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.1 need to install an NGINX Plus JWT
{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.x need to install an NGINX Plus JWT
Secret before upgrading. Follow the steps in the [Before you begin](#before-you-begin) section to create the Secret, which is referenced in the updated deployment manifest for the newest version. {{< /important >}}

{{<tip>}}For guidance on zero downtime upgrades, see the [Delay Pod Termination](#configure-delayed-pod-termination-for-zero-downtime-upgrades) section below.{{</tip>}}
Expand Down
2 changes: 1 addition & 1 deletion site/content/installation/nginx-plus-jwt.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ docs: "DOCS-000"

## Overview

NGINX Gateway Fabric with NGINX Plus requires a valid JSON Web Token (JWT) to download the container image from the F5 registry. From version 1.5.1, this JWT token is also required to run NGINX Plus.
NGINX Gateway Fabric with NGINX Plus requires a valid JSON Web Token (JWT) to download the container image from the F5 registry. From version 1.5.0, this JWT token is also required to run NGINX Plus.

This requirement is part of F5’s broader licensing program and aligns with industry best practices. The JWT will streamline subscription renewals and usage reporting, helping you manage your NGINX Plus subscription more efficiently. The [telemetry](#telemetry) data we collect helps us improve our products and services to better meet your needs.

Expand Down

0 comments on commit 2cbb5d4

Please sign in to comment.