Skip to content

Commit cc2d7c9

Browse files
committed
Add JWT license deployment steps for Config Sync Groups; clarify NIM instance group support
1 parent 9261742 commit cc2d7c9

File tree

3 files changed

+63
-11
lines changed

3 files changed

+63
-11
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](https://docs.nginx.com/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups/) 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: 40 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ 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
17+
## Important changes
1818

19-
##### NGINX Plus won't start if:
19+
### NGINX Plus won't start if:
2020

2121
- The JWT license is missing or invalid.
2222
- The JWT license expired over 90 days ago.
2323

24-
##### NGINX Plus will **stop processing traffic** if:
24+
### NGINX Plus will **stop processing traffic** if:
2525

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

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

4242
---
4343

44-
## Add the JWT license {#add-jwt}
44+
## Download the license from MyF5 {#download-jwt}
4545

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

48-
### Download the license from MyF5 {#download-jwt}
50+
## Deploy the JWT license
4951

50-
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
52+
After you download the JWT license, you can deploy it to your NGINX Plus instances using either of the following methods:
53+
54+
- Use a **Config Sync Group** if you're managing instances with the NGINX One Console (recommended)
55+
- Copy the license manually to each instance
56+
57+
Each method ensures your NGINX Plus instances have access to the required license file.
58+
59+
### Deploy with a Config Sync Group (Recommended)
60+
61+
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](https://docs.nginx.com/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups/). This method lets you:
62+
63+
- Avoid manual file copying
64+
- Keep your fleet consistent
65+
- Automatically apply updates to new NGINX Plus instances
66+
67+
To deploy the JWT license with a Config Sync Group:
68+
69+
{{< include "/licensing-and-reporting/deploy-jwt-with-csgs.md" >}}
70+
71+
Your JWT license now syncs to all NGINX Plus instances in the group.
72+
73+
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.
74+
75+
New instances added to the group automatically inherit the license.
76+
77+
{{< call-out "note" "If you’re using NGINX Instance Manager" "" >}}
78+
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" >}}).
79+
{{< /call-out >}}
80+
81+
### Copy the license manually
5182

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

54-
{{< include "licensing-and-reporting/apply-jwt.md" >}}
85+
{{< include "/licensing-and-reporting/apply-jwt.md" >}}
5586

5687
### Custom paths {#custom-paths}
5788

0 commit comments

Comments
 (0)