From 706ddd4ec1d7cf5a19b5bc30b78ec25a5d49330c Mon Sep 17 00:00:00 2001 From: Saylor Berman Date: Thu, 14 Nov 2024 15:40:03 -0700 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Alan Dooley --- site/content/installation/installing-ngf/helm.md | 4 ++-- site/content/installation/nginx-plus-jwt.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/site/content/installation/installing-ngf/helm.md b/site/content/installation/installing-ngf/helm.md index 763a1a9e3..143a98283 100644 --- a/site/content/installation/installing-ngf/helm.md +++ b/site/content/installation/installing-ngf/helm.md @@ -209,8 +209,8 @@ To upgrade the CRDs, take the following steps: ### Upgrade NGINX Gateway Fabric release -{{}}NGINX Plus users that are upgrading from version 1.4.0 to 1.5.0 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=` when running `helm upgrade`.{{}} +{{< important >}} NGINX Plus users that are upgrading from version 1.4.0 to 1.5.0 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=` when running `helm upgrade`. {{}} #### Upgrade from the OCI registry diff --git a/site/content/installation/nginx-plus-jwt.md b/site/content/installation/nginx-plus-jwt.md index 2d624ec3a..220fd0ef3 100644 --- a/site/content/installation/nginx-plus-jwt.md +++ b/site/content/installation/nginx-plus-jwt.md @@ -7,15 +7,15 @@ 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. In addition, starting with version 1.5.0, 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. The JWT is required for validating your subscription and reporting telemetry data. For environments connected to the internet, telemetry is automatically sent to F5’s licensing endpoint. In offline environments, telemetry is routed through [NGINX Instance Manager](https://docs.nginx.com/nginx-instance-manager/). Usage is reported every hour and on startup whenever NGINX is reloaded. -## Setting up the JWT +## Set up the JWT -The JWT needs to be configured before deploying NGINX Gateway Fabric. We'll store the JWT in two Kubernetes Secrets. One will be used for downloading the NGINX Plus container image, and the other for running NGINX Plus. +The JWT needs to be configured before deploying NGINX Gateway Fabric. The JWT will be stored in two Kubernetes Secrets: one for downloading the NGINX Plus container image, and the other for running NGINX Plus. {{< include "installation/jwt-password-note.md" >}} @@ -172,7 +172,7 @@ ssl_certificate_key /etc/nginx/certs-bootstrap/tls.key; **Once these Secrets are created and configuration options are set, you can now [install NGINX Gateway Fabric]({{< relref "installation/installing-ngf" >}}).** -## Installation flags for configuring usage reporting {#flags} +## Installation flags to configure usage reporting {#flags} When installing NGINX Gateway Fabric, the following flags can be specified to configure usage reporting to fit your needs: @@ -215,7 +215,7 @@ All communication between your NGINX Plus instances, NGINX Instance Manager, and Only **operational metrics** are reported — no **personally identifiable information (PII)** or **sensitive customer data** is transmitted. -## Pulling an image for local use +## Pull an image for local use To pull an image for local use, use this command: