Skip to content

Commit 928e55f

Browse files
travisamartintravisamartin
committed
edits
1 parent 48c964e commit 928e55f

File tree

6 files changed

+98
-74
lines changed

6 files changed

+98
-74
lines changed

‎content/includes/licensing-and-reporting/custom-paths-jwt.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
docs:
33
---
44

5-
If you plan to use a custom path for the license file, note that **custom paths won’t work until after the R33 upgrade**. You’ll need to create a placeholder file at `/etc/nginx/license.jwt` or `/usr/local/etc/nginx/license.jwt` on FreeBSD before upgrading.
5+
If you’re upgrading from NGINX Plus R32 or earlier to R33 or later and plan to use a custom path for the license file, note that the custom path isn’t recognized until after the upgrade. You must first create a placeholder file at `/etc/nginx/license.jwt` (or `/usr/local/etc/nginx/license.jwt` on FreeBSD).
66

7-
1. **Before upgrading**: Create the placeholder file by running:
7+
1. **Before upgrading**: Create the placeholder file:
88

99
```bash
1010
touch /etc/nginx/license.jwt
1111
```
1212

13-
2. **After upgrading**: Update the [`license_token`](https://nginx.org/en/docs/ngx_mgmt_module.html#license_token) directive in the NGINX configuration [`mgmt`](https://nginx.org/en/docs/ngx_mgmt_module.html) block to point to your custom path:
13+
1. **After upgrading**: Update the [`license_token`](https://nginx.org/en/docs/ngx_mgmt_module.html#license_token) directive in the [`mgmt`](https://nginx.org/en/docs/ngx_mgmt_module.html) block of the configuration to point to your custom path:
1414

1515
```nginx
1616
mgmt {

‎content/includes/licensing-and-reporting/log-location-and-monitoring.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
docs:
33
---
44

5-
Monitor the [NGINX error log](https://nginx.org/en/docs/ngx_core_module.html#error_log), typically located at `/var/log/nginx/error.log`, for subscription-related issues — such as failed usage reports or approaching license expirations — to catch problems early and keep your subscription compliant.
5+
Monitor the [NGINX error log](https://nginx.org/en/docs/ngx_core_module.html#error_log), usually located at `/var/log/nginx/error.log`, to identify subscription issues early. The log records problems such as failed usage reports or licenses that are close to expiring. Checking regularly helps you avoid downtime and stay compliant.
66

77
<br>
88

9-
Examples of subscription-related log entries include:
9+
Examples of log entries include:
1010

11-
- **Failure to upload usage reports**:
11+
- **Failed usage reports:**
1212

1313
``` text
1414
[error] 36387#36387: server returned 500 for <fqdn>:<port> during usage report
@@ -17,17 +17,17 @@ Examples of subscription-related log entries include:
1717
[error] 38888#88: server returned 401 for <ip_address>:443 during usage report
1818
```
1919

20-
- **License approaching expiration**:
20+
- **License nearing expiration:**
2121

2222
``` text
2323
[warn] license will expire in 14 days
2424
```
2525

26-
- **License expiration**:
26+
- **License expired:**
2727

2828
``` text
2929
[alert] license expiry; grace period will end in 89 days
3030
[emerg] license expired
3131
```
3232

33-
{{< call-out "important" >}}When a license expires, NGINX Plus stops processing traffic.{{< /call-out >}}
33+
{{< call-out "important" "Important" >}}When a license expires, NGINX Plus stops processing traffic.{{< /call-out >}}

‎content/includes/licensing-and-reporting/reported-usage-data.md‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,39 @@
22
docs:
33
---
44

5-
NGINX Plus automatically sends usage data to F5 every hour by default. This data is sent as a `POST` request and includes details like how much traffic is processed and how long the instance has been running. Here's an example of the data that's sent:
5+
By default, NGINX Plus sends usage data to F5 every hour in a `POST` request. The report includes information such as traffic volume, runtime, and instance activity.
6+
7+
Here’s an example of a usage report:
68

79
```json
810
{
911
"version": "<nginx_version>",
1012
"uuid": "<nginx_uuid>",
11-
"nap": "<active/inactive>", // status of NGINX App Protect
13+
"nap": "<active/inactive>", // NGINX App Protect status
1214
"http": {
1315
"client": {
1416
"received": 0, // bytes received
15-
"sent": 0, // bytes sent
16-
"requests": 0 // number of HTTP requests processed
17+
"sent": 0, // bytes sent
18+
"requests": 0 // HTTP requests processed
1719
},
1820
"upstream": {
1921
"received": 0, // bytes received
20-
"sent": 0 // bytes sent
22+
"sent": 0 // bytes sent
2123
}
2224
},
2325
"stream": {
2426
"client": {
2527
"received": 0, // bytes received
26-
"sent": 0 // bytes sent
28+
"sent": 0 // bytes sent
2729
},
2830
"upstream": {
2931
"received": 0, // bytes received
30-
"sent": 0 // bytes sent
32+
"sent": 0 // bytes sent
3133
}
3234
},
33-
"workers": 0, // number of worker processes running
34-
"uptime": 0, // number of seconds the instance has been running
35-
"reloads": 0, // number of times the instance has been reloaded
36-
"start_time": "epoch", // start time of data collection for the report
37-
"end_time": "epoch" // end time of data collection for the report
38-
}
39-
```
35+
"workers": 0, // number of worker processes running
36+
"uptime": 0, // seconds the instance has been running
37+
"reloads": 0, // number of reloads
38+
"start_time": "epoch", // start of data collection
39+
"end_time": "epoch" // end of data collection
40+
}

‎content/solutions/about-subscription-licenses/getting-started.md‎

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Processing traffic requires:
5656

5757
---
5858

59-
## Deploy the license
59+
## Deploy the license {#deploy-jwt}
6060

6161
After you download the JWT license, you need to deploy it to your NGINX Plus instances. You can do this in one of two ways:
6262

@@ -202,41 +202,55 @@ NGINX Plus will stop processing traffic.
202202

203203
---
204204

205-
## Update the JWT license {#update-jwt}
205+
## Update the license {#update-license}
206206

207207
How you update the JWT license depends on your NGINX Plus release and environment:
208208

209-
- In R35 and later, licenses are applied automatically when the subscription renews (if reporting is configured).
210-
- In earlier releases or disconnected environments, you must update the license manually.
209+
- In R35 and later, the license is updated automatically when the subscription renews (if reporting is configured).
210+
- In earlier releases or disconnected environments, you need to update the license manually.
211211

212-
### Automatic renewal (R35 and later) {#automatic-renewal}
212+
<details>
213+
<summary>Update the license automatically (R35 and later)</summary>
214+
215+
### Automatic update (R35 and later) {#automatic-renewal}
216+
217+
<br>
213218

214-
Starting in NGINX Plus R35, [JWT licenses are renewed automatically](#automatic-renewal) for instances that report directly to the F5 licensing endpoint. NGINX Plus downloads the updated license and applies it without requiring a reload or restart.
219+
Starting in NGINX Plus R35, [JWT licenses are updated automatically](#automatic-renewal) for instances that report directly to the F5 licensing endpoint. NGINX Plus downloads the new license and applies it without requiring a reload or restart.
215220

216-
Here’s how automatic renewal works:
221+
Here’s how the automatic update works:
217222

218223
- Beginning 30 days before the current license expires, NGINX Plus notifies the licensing endpoint as part of usage reporting.
219224
- The licensing endpoint checks for a renewed subscription with F5.
220225
- After the subscription is renewed, the licensing endpoint sends the updated JWT license to the instance.
221-
- NGINX Plus applies the renewed license automatically and stores it as **nginx-mgmt-license** in the [`state_path`](https://nginx.org/en/docs/ngx_mgmt_module.html#state_path) directory.
226+
- NGINX Plus applies the updated license automatically and stores it as **nginx-mgmt-license** in the [`state_path`](https://nginx.org/en/docs/ngx_mgmt_module.html#state_path) directory.
222227
- The original JWT license file at `/etc/nginx/license.jwt` (or a custom path set by [`license_token`](https://nginx.org/en/docs/ngx_mgmt_module.html#license_token)) is not modified. You can replace the original file manually if needed, but this does not affect NGINX Plus operation.
223228
- This process also applies if the license has already expired but is still within the 90-day grace period.
224229
- Traffic continues without interruption.
225230

226231
{{< call-out "important" "Important" >}}
227-
Automatic renewal only works if:
232+
Automatic updates only work if:
228233
- License reporting is configured, and
229234
- At least one usage report has already been sent successfully.
230235

231-
If these conditions aren’t met, you must [update the JWT license manually](#update-jwt).
236+
If these conditions aren’t met, you must [update the JWT license manually](#manually-update-license).
232237
{{< /call-out >}}
233238

234-
### Manual renewal (all releases)
239+
</details>
240+
241+
<details>
242+
<summary>Update the license manually (all releases)</summary>
243+
244+
### Manual update (all releases) {#manually-update-license}
245+
246+
<br>
235247

236-
If auto-renewal is not available (for example, in disconnected environments), update the license manually:
248+
If automatic updates are not available (for example, in disconnected environments), update the license manually:
237249

238250
1. [Download the new JWT license](#download-jwt) from MyF5.
239-
1. [Deploy the JWT license](#deploy-the-jwt-license) to your NGINX Plus instances.
251+
2. [Deploy the JWT license](#deploy-jwt) to your NGINX Plus instances.
252+
253+
</details>
240254

241255
---
242256

‎content/solutions/about-subscription-licenses/instructional-videos.md‎

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,43 @@
11
---
2-
# We use sentence case and present imperative tone
32
title: "Watch instructional videos"
4-
# Weights are assigned in increments of 100: determines sorting order
53
weight: 300
6-
# Creates a table of contents and sidebar, useful for large documents
74
toc: false
8-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
95
nd-content-type: reference
10-
# Intended for internal catalogue and search, case sensitive:
11-
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
126
nd-product: Solutions
137
---
148

9+
## Instructional videos for NGINX Plus subscription licensing
10+
11+
These tutorials show how to complete common subscription licensing tasks in NGINX Plus. They cover setting up usage reporting in connected and disconnected environments, and installing or upgrading to NGINX Plus R33 or later.
12+
1513
## Submit usage reports in a connected environment
16-
{{< youtube id="PDnacyh2RUw" >}}
14+
15+
{{< youtube id="PDnacyh2RUw" >}}
16+
17+
Learn how to configure NGINX Plus to send usage reports directly to the F5 licensing endpoint.
18+
19+
See also:
20+
21+
- [Prepare your environment for reporting]({{< ref "solutions/about-subscription-licenses/getting-started.md#set-up-environment" >}})
1722

1823
## Submit usage reports in a disconnected environment
24+
1925
{{< youtube id="4wIM21bR9-g" >}}
2026

21-
## Install or upgrade to NGINX Plus R33
22-
{{< youtube id="zHd7btagJRM" >}}
27+
Learn how to configure NGINX Plus to send usage data to NGINX Instance Manager.
28+
NGINX Instance Manager collects the reports and later forwards them to the F5 licensing endpoint.
29+
30+
See also:
31+
32+
- [Prepare your environment for reporting]({{< ref "solutions/about-subscription-licenses/getting-started.md#set-up-environment" >}})
33+
- [Submit usage reports to F5 from NGINX Instance Manager]({{< ref "/nim/disconnected/report-usage-disconnected-deployment.md" >}})
34+
35+
## Install or upgrade to NGINX Plus R33 or later
36+
37+
{{< youtube id="zHd7btagJRM" >}}
38+
39+
Learn how to install or upgrade to NGINX Plus.
40+
41+
See also:
42+
43+
- [NGINX Plus installation guide]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}})

‎content/solutions/about-subscription-licenses/related-topics.md‎

Lines changed: 17 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,36 @@
11
---
2-
# We use sentence case and present imperative tone
32
title: "Learn more about related topics"
4-
# Weights are assigned in increments of 100: determines sorting order
5-
weight: i00
6-
# Creates a table of contents and sidebar, useful for large documents
3+
weight: 900
74
toc: false
8-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
95
nd-content-type: how-to
10-
# Intended for internal catalogue and search, case sensitive:
11-
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12-
nd-product:
6+
nd-product: Solutions
137
---
148

15-
## NGINX Plus
16-
17-
### NGINX Plus installation guide
9+
When you set up [NGINX Plus subscription licensing]({{< ref "/solutions/about-subscription-licenses/getting-started.md" >}}), you may also need details from other products. This page links to installation guides, module references, and reporting instructions that support licensing and related features.
1810

19-
For detailed instructions on installing or upgrading NGINX Plus, visit the [NGINX Plus installation guide]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}).
20-
21-
### `mgmt` module and directives
11+
## NGINX Plus
2212

23-
For full details about the `mgmt` module and its directives, visit the [Module ngx_mgmt_module reference guide](https://nginx.org/en/docs/ngx_mgmt_module.html).
13+
- [NGINX Plus installation guide]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) – Instructions for installing or upgrading NGINX Plus.
14+
- [Module ngx_mgmt_module reference](https://nginx.org/en/docs/ngx_mgmt_module.html) – Details about the `mgmt` module and its directives, including license and reporting configuration.
2415

2516
## NGINX Instance Manager
2617

27-
The instructions below use the terms "internet-connected" and "network-restricted" to describe how NGINX Instance Manager accesses the internet.
18+
NGINX Instance Manager is required for usage reporting in network-restricted environments.
19+
In this setup, NGINX Plus instances send usage data to Instance Manager, which then forwards the reports to F5.
2820

29-
### License NGINX Instance Manager
21+
- **Internet-connected environments**
22+
- [Add a license]({{< ref "nim/admin-guide/add-license.md" >}})
23+
- [Report usage to F5]({{< ref "nim/admin-guide/report-usage-connected-deployment.md" >}})
3024

31-
- **Internet-connected**: Follow the steps in [Add license]({{< ref "nim/admin-guide/add-license.md" >}}).
32-
- **Network-restricted**: Follow the steps in [Add a license in a disconnected environment]({{< ref "nim/disconnected/add-license-disconnected-deployment.md" >}}).
33-
34-
### Submit usage reports to F5 from NGINX Instance Manager {#submit-usage-reports-from-nim}
35-
36-
- **Internet-connected**: Follow the steps in [Report usage to F5]({{< ref "nim/admin-guide/report-usage-connected-deployment.md" >}}).
37-
- **Network-restricted**: Follow the steps in [Report usage to F5 in a disconnected environment]({{< ref "nim/disconnected/report-usage-disconnected-deployment.md" >}}).
25+
- **Network-restricted environments**
26+
- [Add a license in a disconnected environment]({{< ref "nim/disconnected/add-license-disconnected-deployment.md" >}})
27+
- [Report usage to F5 in a disconnected environment]({{< ref "nim/disconnected/report-usage-disconnected-deployment.md" >}})
3828

3929
## NGINX App Protect WAF
4030

41-
For details on installing or upgrading NGINX App Protect WAF, visit the guide for the respective version:
42-
43-
- [NGINX App Protect WAF v4 installation guide]({{< ref "/nap-waf/v4/admin-guide/install.md" >}})
44-
- [NGINX App Protect WAF v5 installation guide]({{< ref "/nap-waf/v5/admin-guide/install.md" >}})
31+
- [NGINX App Protect WAF v4 installation guide]({{< ref "/nap-waf/v4/admin-guide/install.md" >}})
32+
- [NGINX App Protect WAF v5 installation guide]({{< ref "/nap-waf/v5/admin-guide/install.md" >}})
4533

4634
## NGINX App Protect DoS
4735

48-
For detailed instructions on installing or upgrading NGINX App Protect DoS, visit the [NGINX App Protect DoS installation guide]({{< ref "/nap-dos/deployment-guide/learn-about-deployment.md" >}}).
36+
- [NGINX App Protect DoS installation guide]({{< ref "/nap-dos/deployment-guide/learn-about-deployment.md" >}})

0 commit comments

Comments
 (0)