Skip to content

Commit 0b9e334

Browse files
Add JWT license deployment steps for Config Sync Groups; clarify NIM instance group support (#865)
* Add JWT license deployment steps for Config Sync Groups; clarify NIM instance group support
1 parent c3ddda6 commit 0b9e334

File tree

3 files changed

+64
-12
lines changed

3 files changed

+64
-12
lines changed

content/includes/licensing-and-reporting/apply-jwt.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,12 @@ file:
55
- content/nap-waf/v5/admin-guide/install.md
66
---
77

8-
1. Copy the license file to `/etc/nginx/license.jwt` on Linux or `/usr/local/etc/nginx/license.jwt` on FreeBSD for each NGINX Plus instance.
9-
2. Reload NGINX:
8+
1. Copy the license file to:
9+
10+
- `/etc/nginx/license.jwt` on Linux
11+
- `/usr/local/etc/nginx/license.jwt` on FreeBSD
12+
13+
1. Reload NGINX:
1014

1115
```shell
1216
systemctl reload nginx
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
docs:
3+
file:
4+
- content/solutions/about-subscription-licenses.md
5+
---
6+
7+
1. In the NGINX One Console, go to **Manage > Config Sync Groups**, then select your group.
8+
9+
If you haven't created a Config Sync Group yet, see [Manage Config Sync Groups]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md" >}}) for setup instructions.
10+
2. Select the **Configuration** tab, then choose **Edit Configuration**.
11+
3. Select **Add File**, then choose **New Configuration File**.
12+
4. In the **File name** field, enter:
13+
- On Linux: `/etc/nginx/license.jwt`
14+
- On FreeBSD: `/usr/local/etc/nginx/license.jwt`
15+
The name must be exact.
16+
5. Paste the contents of your JWT license file into the editor.
17+
6. Select **Next** to preview the diff, then **Save and Publish** to apply the update.

content/solutions/about-subscription-licenses.md

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ We’re updating NGINX Plus to align with F5’s entitlement and visibility poli
1414

1515
Starting with NGINX Plus R33, all **NGINX Plus instances require a valid JSON Web Token (JWT) license**. This license is tied to your subscription (not individual instances) and is used to validate your subscription and automatically send usage reports to F5's licensing endpoint (`product.connect.nginx.com`), as required by your subscription agreement. In offline environments, usage reporting is [routed through NGINX Instance Manager]({{< ref "nim/disconnected/report-usage-disconnected-deployment.md" >}}).
1616

17+
## Important changes
18+
1719
If you have multiple subscriptions, you’ll also have multiple JWT licenses. You can assign each NGINX Plus instance to the license you prefer. NGINX combines usage reporting across all licensed instances.
1820

1921
This feature is available in NGINX Instance Manager 2.20 and later.
2022

21-
### Important changes
22-
23-
##### NGINX Plus won't start if:
23+
### NGINX Plus won't start if:
2424

2525
- The JWT license is missing or invalid.
2626
- The JWT license expired over 90 days ago.
2727

28-
##### NGINX Plus will **stop processing traffic** if:
28+
### NGINX Plus will **stop processing traffic** if:
2929

3030
- It can't submit an initial usage report to F5's licensing endpoint or NGINX Instance Manager.
3131

@@ -45,17 +45,48 @@ When installing or upgrading to NGINX Plus R33 or later, take the following step
4545

4646
---
4747

48-
## Add the JWT license {#add-jwt}
48+
## Download the license from MyF5 {#download-jwt}
4949

50-
Before you install or upgrade to NGINX Plus R33 or later, make sure to:
50+
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
5151

52-
### Download the license from MyF5 {#download-jwt}
52+
---
5353

54-
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
54+
## Deploy the JWT license
55+
56+
After you download the JWT license, you can deploy it to your NGINX Plus instances using either of the following methods:
57+
58+
- Use a **Config Sync Group** if you're managing instances with the NGINX One Console (recommended)
59+
- Copy the license manually to each instance
60+
61+
Each method ensures your NGINX Plus instances have access to the required license file.
62+
63+
### Deploy with a Config Sync Group (Recommended)
64+
65+
If you're using the [NGINX One Console]({{< ref "/nginx-one/getting-started.md" >}}), the easiest way to manage your JWT license is with a [Config Sync Group]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md" >}}). This method lets you:
66+
67+
- Avoid manual file copying
68+
- Keep your fleet consistent
69+
- Automatically apply updates to new NGINX Plus instances
70+
71+
To deploy the JWT license with a Config Sync Group:
72+
73+
{{< include "/licensing-and-reporting/deploy-jwt-with-csgs.md" >}}
74+
75+
Your JWT license now syncs to all NGINX Plus instances in the group.
76+
77+
When your subscription renews and a new JWT license is issued, update the file in the Config Sync Group to apply the change across your fleet.
78+
79+
New instances added to the group automatically inherit the license.
80+
81+
{{< call-out "note" "If you’re using NGINX Instance Manager" "" >}}
82+
If you're using NGINX Instance Manager instead of the NGINX One Console, the equivalent feature is called an *instance group*. You can manage your JWT license in the same way by adding or updating the file in the instance group. For details, see [Manage instance groups]({{< ref "/nim/nginx-instances/manage-instance-groups.md" >}}).
83+
{{< /call-out >}}
84+
85+
### Copy the license manually
5586

56-
### Copy the license to each NGINX Plus instance
87+
If you're not using NGINX One, copy the JWT license file to each NGINX Plus instance manually.
5788

58-
{{< include "licensing-and-reporting/apply-jwt.md" >}}
89+
{{< include "/licensing-and-reporting/apply-jwt.md" >}}
5990

6091
### Custom paths {#custom-paths}
6192

0 commit comments

Comments
 (0)