Skip to content

Commit 779eb54

Browse files
authored
feat: Update Security Monitoring section, fix NAP link (#49)
This commit updates the Security Monitoring section to fit contemporary style standards: sentence case for titles, no gerunds, horizontal line breaks at the end of sections. It also fixes the frontmatter for the section's pages to be uniform in order and parameters with newer pages, and adds explicit weights for page numbering. The final change is to add a reference link to the right NAP V4 page: prior to the release of NAP V5 the link was valid, but was not automatically detected due to being a production URL.
1 parent 876f2b9 commit 779eb54

File tree

12 files changed

+105
-108
lines changed

12 files changed

+105
-108
lines changed
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Configure
33
description:
4-
weight: 100
5-
url: /nginx-instance-manager/monitoring/security-monitoring/configure/
4+
weight: 200
65
---
Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,29 @@
11
---
2+
title: Add user access to Security Monitoring dashboards
23
description: Learn how to grant users access to the F5 NGINX Security Monitoring dashboards.
3-
docs: DOCS-1026
4-
doctypes:
5-
- task
6-
tags:
7-
- docs
8-
title: Give Users Access to Security Monitoring Dashboards
94
toc: true
105
weight: 200
11-
---
6+
doctype: how-to
7+
product: NIM
8+
docs: DOCS-1026
129

13-
{{< shortversions "1.0.0" "latest" "secvers" >}}
10+
---
1411

1512
## Overview
1613

1714
You can use F5 NGINX Security Monitoring to monitor NGINX App Protect WAF instances. The Security Monitoring analytics dashboards and security logs provide protection insights and help you analyze possible threats or identify opportunities to tune your security policies.
1815

1916
By completing the steps in this topic, you will create a role that gives users access to the Security Monitoring module and logs, and assign it to user accounts or groups.
2017

21-
{{<note>}}The recommendations in this guide follow the principle of least privilege and do not grant users access to NGINX Instance Manager. You can create additional roles with custom modules, features, and permissions to suit your use case.{{</note>}}
18+
{{< note >}} The recommendations in this guide follow the principle of least privilege and do not grant users access to NGINX Instance Manager. You can create additional roles with custom modules, features, and permissions to suit your use case. {{</ note >}}
19+
20+
---
2221

23-
## Before You Begin
22+
## Before you begin
2423

2524
Complete the following prerequisites before proceeding with this guide:
2625

27-
- NGINX Security Monitoring is [installed]({{< relref "/nim/monitoring/security-monitoring/deploy/install-security-monitoring.md" >}}) and running.
26+
- NGINX Security Monitoring is [installed]({{< relref "/nim/monitoring/security-monitoring/install-security-monitoring.md" >}}) and running.
2827
- Your user account needs to be able to access the User Management settings in NGINX Instance Manager.
2928
The minimum required role permissions are:
3029

@@ -44,19 +43,26 @@ Complete the following prerequisites before proceeding with this guide:
4443

4544
{{</bootstrap-table>}}
4645

46+
---
4747

48-
## Create a Role
48+
## Create a role
4949

5050
{{< include "nim/rbac/create-roles.md" >}}
5151

52-
## Assign the Role
52+
---
53+
54+
## Assign the role
5355

5456
After you've created a role for Security Monitoring, assign the role to one or more users or to a user group.
5557

56-
### Assign the Role to Users
58+
---
59+
60+
### Assign the role to users
5761

5862
{{< include "nim/rbac/assign-roles-to-users.md" >}}
5963

60-
### Assign the Role to User Groups
64+
---
65+
66+
### Assign the role to user groups
6167

6268
{{< include "nim/rbac/assign-roles-to-user-groups.md" >}}

content/nim/monitoring/security-monitoring/configure/set-up-app-protect-instances.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
---
2+
title: Create App Protect WAF instances for Security Monitoring
23
description: Learn how to set up F5 NGINX App Protect data plane instances for use with
34
the NGINX Security Monitoring and NGINX Instance Manager.
4-
docs: DOCS-1107
5-
doctypes:
6-
- task
7-
tags:
8-
- docs
9-
title: Set Up App Protect Instances for Security Monitoring
105
toc: true
116
weight: 100
7+
type: how-to
8+
product: NIM
9+
docs: DOCS-1107
1210
---
1311

1412
## Overview
@@ -18,7 +16,9 @@ F5 NGINX Security Monitoring supports the following use cases:
1816
- **Security Monitoring only**: Use only the Security Monitoring module to monitor data from NGINX App Protect WAF instances. You will be able to review the security dashboards to assess potential threats and identify opportunities to fine-tune your policies. Your NGINX App Protect WAF configurations are managed outside of the NGINX Instance Manager context.
1917
- **Security Monitoring and Instance Manager**: Use the Security Monitoring module with the NGINX Instance Manager. In addition to monitoring your application security, you will be able to manage your NGINX App Protect WAF configurations and security policies in a single location and push pre-compiled updates to an instance or instance group.
2018

21-
### Before You Begin
19+
---
20+
21+
## Before you begin
2222

2323
Complete the following prerequisites before proceeding with the steps in this guide.
2424

@@ -32,10 +32,11 @@ Complete the following prerequisites before proceeding with the steps in this gu
3232
{{< include "nim/tech-specs/security-data-plane-dependencies.md" >}}
3333

3434
1. Determine your use case: **Security Monitoring only** or **Security Monitoring and Configuration Management**.
35-
1. [Install the NGINX Security Monitoring module]({{< relref "/nim/monitoring/security-monitoring/deploy/install-security-monitoring.md" >}}) and [upload your license]({{< relref "/nim/admin-guide/license/add-license.md" >}}).
35+
1. [Install the NGINX Security Monitoring module]({{< relref "/nim/monitoring/security-monitoring/install-security-monitoring.md" >}}) and [upload your license]({{< relref "/nim/admin-guide/license/add-license.md" >}}).
3636

37+
---
3738

38-
## Install NGINX Agent {#agent-config}
39+
## Install NGINX Agent
3940

4041
NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instance that provides:
4142

@@ -144,7 +145,9 @@ sudo sh ./install.sh --nap-monitoring true --nginx-app-protect-mode precompiled-
144145
sudo systemctl restart nginx-agent
145146
```
146147

147-
## Set Up Instances for Security Monitoring Only {#monitor-only}
148+
---
149+
150+
## Create instances for Security Monitoring only
148151

149152
Complete the steps in this section if you are only using the Security Monitoring module to monitor your application security. In this use case, you are **not using Instance Manager** to manage your WAF security policies.
150153

@@ -198,7 +201,9 @@ Repeat the steps below on each NGINX App Protect WAF data plane instance.
198201

199202
You should now be able to view data from your NGINX App Protect instances in the NGINX Security Monitoring dashboards.
200203

201-
## Set up Instances for Security Monitoring with Instance Manager {#monitor-and-manage}
204+
---
205+
206+
## Create instances for Security Monitoring with Instance Manager
202207

203208
Complete the steps in this section if you want to use the Security Monitoring module **and** Instance Manager. In this use case, you will use NGINX Instance Manager to monitor threats and to manage your NGINX App Protect WAF configurations and security policies.
204209

@@ -235,7 +240,7 @@ Take the steps below to update your NGINX App Protect WAF configurations by usin
235240

236241
You should now be able to view data from your NGINX App Protect WAF instances in the Security Monitoring dashboard.
237242

238-
## What's Next
243+
## See also
239244

240245
- [Grant Users Access to the Security Monitoring Dashboards]({{< relref "create-role-security-monitoring" >}}): Follow the steps in this guide to allow other users in your organization to access the Security Monitoring Dashboards.
241246

content/nim/monitoring/security-monitoring/configure/update-geo-db.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,39 @@
11
---
2+
title: Update the geolocation database used in dashboards
23
description: Learn how to update the Geolocation Database used in F5 NGINX Management
34
Suite Security Monitoring dashboards.
4-
docs: DOCS-1108
5-
doctypes:
6-
- task
7-
tags:
8-
- docs
9-
title: Update Geolocation Database used in Security Monitoring Dashboards
105
toc: true
11-
weight: 200
6+
weight: 400
7+
type: how-to
8+
product: NIM
9+
docs: DOCS-1108
1210
---
1311

14-
{{< shortversions "1.0.0" "latest" "secvers" >}}
15-
16-
17-
1812
## Overview
1913

2014
You can use F5 NGINX Security Monitoring to monitor NGINX App Protect WAF instances. The Security Monitoring analytics dashboard uses MaxMind's GeoLite2 Free Database to provide extra Geolocation data for Security Violations.
2115

2216
By completing the steps in this topic, you will be able to update the Security Monitoring module to get the latest Geolocation database such that the dashboards can provide accurate data.
2317

24-
## Before You Begin
18+
---
19+
20+
## Before you begin
2521

2622
Complete the following prerequisites before proceeding with this guide:
2723

28-
- NGINX Security Monitoring is [installed]({{< relref "/nim/monitoring/security-monitoring/deploy/install-security-monitoring.md" >}}) and running.
24+
- NGINX Security Monitoring is [installed]({{< relref "/nim/monitoring/security-monitoring/install-security-monitoring.md" >}}) and running.
2925
- NGINX App Protect is configured, and the Security Monitoring dashboard is gathering security violations
3026

31-
## How to update Geolocation Database
27+
28+
---
29+
30+
## Update the geolocation database
3231

3332
1. Create a [MaxMind](https://dev.maxmind.com/geoip/geolite2-free-geolocation-data/) account and subscribe to get the latest updates to the Geolocation database.
3433
1. Download the GeoLite2 Country (Edition ID: GeoLite2-Country) database in a GeoIP2 Binary `.mmdb` format from the [MaxMind](https://www.maxmind.com/en/accounts/current/geoip/downloads) website. The database will be present in a `gzip` downloaded file.
3534
1. Unzip the downloaded `gzip` file, which contains the binary data of the GeoLite2 Country database with a filename `GeoLite2-Country.mmdb`
3635
1. Replace the `GeoLite2-Country.mmdb` present on your NGINX Instance Manager's Control Plane at `/usr/share/nms/geolite2/GeoLite2-Country.mmdb` with the newly downloaded GeoLite2 Country database.
3736

38-
Example:
39-
4037
```bash
4138
sudo scp /path/to/GeoLite2-Country.mmdb {user}@{host}:/usr/share/nms/geolite2/GeoLite2-Country.mmdb
4239
```
Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
---
2+
title: Update the Attack Signature Database
23
description: Learn how to update the Attack Signature Database used in F5 NGINX Management
34
Suite Security Monitoring dashboards.
4-
docs: DOCS-1109
5-
doctypes:
6-
- task
7-
tags:
8-
- docs
9-
title: Manage the Security Monitoring Signature Database
105
toc: true
11-
weight: 200
6+
weight: 300
7+
type: how-to
8+
product: NIM
9+
docs: DOCS-1109
1210
---
1311

14-
{{< shortversions "1.0.0" "latest" "secvers" >}}
15-
1612
## Overview
1713

18-
You can use the F5 NGINX Security Monitoring module to monitor NGINX App Protect WAF instances for security. The Security Monitoring module analytics dashboards utilize a Signature Database to give more detail about the Attack Signatures that have caused a Security Violation, like the Signature's name, accuracy, and risk. If the Signature Database is not updated to match the Attack Signature version used for App Protect WAF protection, new signatures may be triggered without a name or other attributes like risk and accuracy.
14+
You can use the F5 NGINX Security Monitoring module to monitor NGINX App Protect WAF instances for security. The Security Monitoring module analytics dashboards utilize a Signature Database to give more detail about the Attack Signatures that have caused a Security Violation, like the Signature's name, accuracy, and risk.
1915

20-
Make sure the dashboards show the right info by following the steps in this topic to update the Security Monitoring module with the newest Attack Signature data.
16+
If the Signature Database is not updated to match the Attack Signature version used for App Protect WAF protection, new signatures may be triggered without a name or other attributes like risk and accuracy.
17+
18+
The steps in this topic ensure that dashboards show the correct information by updating the Security Monitoring module with the newest Attack Signature data.
19+
20+
---
2121

22-
## Before You Begin
22+
## Before you begin
2323

2424
Complete the following prerequisites before proceeding with this guide:
2525

26-
- NGINX Security Monitoring is [installed]({{< relref "/nim/monitoring/security-monitoring/deploy/install-security-monitoring.md" >}}) and running
26+
- NGINX Security Monitoring is [installed]({{< relref "/nim/monitoring/security-monitoring/install-security-monitoring.md" >}}) and running
2727
- NGINX App Protect is configured, and the Security Monitoring dashboard is gathering security violations
2828

29-
## How to Update the Signature Database
29+
---
3030

31-
1. Open an SSH connection to the data plane host and log in.
32-
1. Use the [Attack Signature Report Tool](https://docs.nginx.com/nginx-app-protect/configuration-guide/configuration/#attack-signature-report-tool) to generate a Signature Report file. The filename must be `signature-report.json`.
31+
## Update the Signature Database
3332

34-
Example:
33+
1. Open an SSH connection to the data plane host and log in.
34+
1. Use the [Attack Signature Report Tool]({{< relref "/nap-waf/v4/configuration-guide/configuration.md#attack-signature-report-tool" >}}) to generate a Signature Report file. The filename must be `signature-report.json`.
3535

3636
```bash
3737
sudo /opt/app_protect/bin/get-signatures -o ./signature-report.json
@@ -40,8 +40,6 @@ Complete the following prerequisites before proceeding with this guide:
4040
1. Open an SSH connection to the management plane host and log in.
4141
1. Replace the `signature-report.json` on your NGINX Instance Manager's control plane at `/usr/share/nms/sigdb/signature-report.json` with the newly generated Signature Report.
4242
43-
Example:
44-
4543
```bash
4644
sudo scp /path/to/signature-report.json {user}@{host}:/usr/share/nms/sigdb/signature-report.json
4745
```
@@ -51,4 +49,4 @@ Complete the following prerequisites before proceeding with this guide:
5149
```bash
5250
sudo systemctl restart nms-ingestion
5351
sudo systemctl restart nms-core
54-
```
52+
```

content/nim/monitoring/security-monitoring/deploy/_index.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

content/nim/monitoring/security-monitoring/deploy/install-security-monitoring.md renamed to content/nim/monitoring/security-monitoring/install-security-monitoring.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,32 @@
11
---
2-
description:
3-
docs: DOCS-1208
4-
doctypes:
5-
- tutorial
6-
tags:
7-
- docs
8-
title: "Install or Upgrade Security Monitoring"
2+
title: "Install or upgrade Security Monitoring"
93
toc: true
10-
weight: 40
4+
weight: 100
5+
doctype: how-to
6+
product: NIM
7+
docs: DOCS-1208
118
---
129

1310
## Overview
1411

1512
Follow the steps in this guide to install or upgrade or upgrade the NGINX Security Monitoring module.
1613

17-
## Before You Begin
14+
---
15+
16+
## Before you begin
1817

19-
### Security Considerations
18+
### Security considerations
2019

2120
{{< include "installation/secure-installation.md" >}}
2221

23-
### Installation Prerequisites
22+
---
23+
24+
### Installation prerequisites
2425

2526
{{< include "installation/nms-prerequisites.md" >}}
2627

28+
---
29+
2730
### Dependencies with Instance Manager
2831

2932
{{< include "nim/tech-specs/security-management-plane-dependencies.md" >}}
@@ -77,19 +80,24 @@ Follow the steps in this guide to install or upgrade or upgrade the NGINX Securi
7780
```
7881

7982

80-
### Accessing the Web Interface
83+
---
84+
85+
### Access the web interface
8186

8287
{{< include "installation/access-web-ui.md" >}}
8388

84-
### Add License
89+
90+
---
91+
92+
### Add license
8593

8694
A valid license is required to make full use of all the features in Security Monitoring module.
8795

8896
Refer to the [Add a License]({{< relref "/nim/admin-guide/license/add-license.md" >}}) topic for instructions on how to download and apply a trial license, subscription license, or Flexible Consumption Program license.
8997

9098
---
9199

92-
## Upgrade Security Monitoring {#upgrade-security-monitoring}
100+
## Upgrade Security Monitoring
93101

94102
{{<call-out "important" "Instance Manager Dependency" >}}The upgrade process for Security Monitoring **does not** automatically upgrade Instance Manager, which is a package dependency. To ensure compatibility with Security Monitoring, you will need to manually [upgrade Instance Manager]({{< relref "/nim/deploy/vm-bare-metal/install.md#upgrade-nim" >}}) to a version supported by Security Monitoring. For specific version dependencies between Security Monitoring and Instance Manager, refer to the [Security Monitoring release notes]({{< relref "/nim/monitoring/security-monitoring/releases/release-notes.md" >}}).{{</call-out>}}
95103

@@ -142,10 +150,8 @@ Refer to the [Add a License]({{< relref "/nim/admin-guide/license/add-license.md
142150

143151
---
144152

145-
## What's Next
146-
147-
### Set Up Data Plane
153+
## See also
148154

149155
To set up your NGINX App Protect WAF data plane instances for use with Security Monitoring, refer to the following instructions:
150156

151-
- [Set Up App Protect Instances for Security Monitoring]({{< relref "/nim/monitoring/security-monitoring/configure/set-up-app-protect-instances" >}})
157+
- [Create App Protect WAF instances for Security Monitoring]({{< relref "/nim/monitoring/security-monitoring/configure/set-up-app-protect-instances" >}})
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Releases
33
description: "Stay up-to-date with the latest F5 NGINX Security Monitoring releases."
4-
weight: 800
5-
url: /nginx-instance-manager/monitoring/security-monitoring/releases/
4+
weight: 300
65
---

0 commit comments

Comments
 (0)