Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Update NMS and Security Monitoring mentions within NIM docset #140

Closed
wants to merge 7 commits into from
8 changes: 4 additions & 4 deletions content/nap-waf/v4/admin-guide/upgrade-nap-waf.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Upgrade NGINX App Protect WAF on Managed Instances"
description: "How to Upgrade F5 NGINX App Protect WAF on managed NGINX instances"
title: Upgrade NGINX App Protect WAF on Managed Instances
weight: 300
toc: true
tags: [ "NGINX Management Suite" ]
docs: "DOCS-1198"
type: how-to
product: NAP-WAF
docs: DOCS-1198
---

## Overview
Expand Down
8 changes: 4 additions & 4 deletions content/nap-waf/v5/admin-guide/upgrade-nap-waf.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Upgrade NGINX App Protect WAF on Managed Instances"
description: "How to Upgrade F5 NGINX App Protect WAF on managed NGINX instances"
title: Upgrade NGINX App Protect WAF on Managed Instances
weight: 600
toc: true
tags: [ "NGINX Management Suite" ]
docs: "DOCS-1640"
type: how-to
product: NAP-WAF
docs: DOCS-1640
---

## Overview
Expand Down
6 changes: 2 additions & 4 deletions content/nginx/_index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
description: "Documentation for NGINX Open Source and F5 NGINX Plus. \n\nRequest your
[free 30‑day trial](https://www.nginx.com/free-trial-request) today.\n"
linkTitle: NGINX Plus
menu: docs
title: F5 NGINX Plus
weight: 100
description: "Documentation for NGINX Open Source and F5 NGINX Plus. \n\nRequest your
[free 30‑day trial](https://www.nginx.com/free-trial-request) today.\n"
cascade:
logo: "NGINX-Plus-product-icon-RGB.svg"
---
2 changes: 1 addition & 1 deletion content/nim/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: NGINX Instance Manager
title: F5 NGINX Instance Manager
description: Track and control NGINX Open Source and NGINX Plus instances.
url: /nginx-instance-manager/
cascade:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
docs: DOCS-1197
doctypes:
- tutorial
tags:
- docs
title: Automate OIDC with Microsoft Entra
toc: true
weight: 300
toc: true
type: how-to
product: NIM
docs: DOCS-1197
---

## Overview
Expand Down Expand Up @@ -50,7 +48,7 @@ Before proceeding, first secure NGINX Instance Manager with OpenID Connect (OIDC
3. Fill in the role details. Use the information from an existing user group in NGINX Instance Manager, such as from the [Create user groups in Instance Manager]({{< relref "/nim/admin-guide/authentication/oidc/microsoft-entra-setup.md#create-user-groups-in-nginx-instance-manager" >}}) step:
- In the **Display name** field, enter a role name (e.g., "Admin").
- In **Allowed member types**, select **Applications**.
- In the **Value** field, enter the value for the role. This must match the user group in NGINX Management Suite.
- In the **Value** field, enter the value for the role. This must match the user group in Instance Manager.
- Provide a description for the role.
4. Select **Save**.

Expand Down Expand Up @@ -158,12 +156,12 @@ Additionally, complete the following steps:

{{< note >}}The `roles` claim will contain the role ID of the role you created in the [Create an app role](#create-app-role) step.{{< /note >}}

## Access NGINX Management Suite API using the access token
## Access NGINX Instance Manager API using the access token

To access the NGINX Management Suite API using the access token, send the token in the `Authorization` header of the request as a Bearer token. For example, using `curl`:
To access the NGINX Instance Manager API using the access token, send the token in the `Authorization` header of the request as a Bearer token. For example, using `curl`:

```bash
curl -v -k --header "Authorization: Bearer <access-token>" https://<nms-ip>/api/platform/v1/userinfo
```

Replace `<access-token>` with the token you obtained from Microsoft Entra and `<nms-ip>` with the IP address of your NGINX Management Suite instance.
Replace `<access-token>` with the token you obtained from Microsoft Entra and `<nms-ip>` with the IP address of your NGINX Instance Manager instance.
13 changes: 5 additions & 8 deletions content/nim/deploy/vm-bare-metal/install-nim-deprecated.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
---
description:
docs: DOCS-1211
doctypes:
- tutorial
tags:
- docs
title: Manually install on a virtual machine or bare metal (deprecated)
toc: true
weight: 10
toc: true
noindex: true
type: how-to
product: NIM
docs: DOCS-1211
---


Expand Down Expand Up @@ -316,4 +313,4 @@ To install NGINX Instance Manager, you need to add the official repository to pu
sudo systemctl restart nginx
```

4. (Optional) If you use SELinux, follow the steps in the [Configure SELinux]({{< relref "nim/system-configuration/configure-selinux.md" >}}) guide to restore the default SELinux labels (`restorecon`) for the files and directories related to NGINX Management suite.
4. (Optional) If you use SELinux, follow the steps in the [Configure SELinux]({{< relref "nim/system-configuration/configure-selinux.md" >}}) guide to restore the default SELinux labels (`restorecon`) for the files and directories related to NGINX Instance Manager.
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
---
title: Add user access to Security Monitoring dashboards
description: Learn how to grant users access to the F5 NGINX Security Monitoring dashboards.
toc: true
weight: 200
toc: true
doctype: how-to
product: NIM
docs: DOCS-1026

---

## Overview

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.
You can use the Security Monitoring module 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming in NIM 2.19, Sec Mon will be a built-in feature of NIM and not a standalone module.


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.

Expand All @@ -23,25 +21,20 @@ By completing the steps in this topic, you will create a role that gives users a

Complete the following prerequisites before proceeding with this guide:

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

- **Module**: Settings
- **Feature**: User Management
- **Access**: `READ`, `CREATE`, `UPDATE`

- Review the table below to determine the minimum permissions needed for your use case.

{{<bootstrap-table "table table-bordered table-hover">}}

| Module(s) | Feature(s) | Access | Description |
|-------|--------|----|--------|
| Instance&nbsp;Manager <hr> Security&nbsp;Monitoring | Analytics <hr> Security&nbsp;Monitoring | READ <hr> READ | Read-only access that allows users to view the Security Monitoring dashboards. Users cannot access NGINX Instance Manager or Settings.|
| Instance&nbsp;Manager <hr> Security&nbsp;Monitoring <hr> Settings | Analytics <hr> Security&nbsp;Monitoring <hr>User Management | READ <hr> READ <hr> CREATE,&nbsp;READ,&nbsp;UPDATE| Allows users to view the Security Monitoring dashboards and manage user accounts and roles.<br><br>{{< fa "lightbulb" >}} Recommended for a "super-user" who is responsible for managing other users' access to the security dashboards. This permission set does not allow the user to delete user accounts.|

Review the table below to determine the minimum permissions needed for your use case.

{{</bootstrap-table>}}
| Module(s) | Feature(s) | Access | Description |
|-------|--------|----|--------|
| Instance&nbsp;Manager <hr> Security&nbsp;Monitoring | Analytics <hr> Security&nbsp;Monitoring | READ <hr> READ | Read-only access that allows users to view the Security Monitoring dashboards. Users cannot access NGINX Instance Manager or Settings.|
| Instance&nbsp;Manager <hr> Security&nbsp;Monitoring <hr> Settings | Analytics <hr> Security&nbsp;Monitoring <hr>User Management | READ <hr> READ <hr> CREATE,&nbsp;READ,&nbsp;UPDATE| Allows users to view the Security Monitoring dashboards and manage user accounts and roles.<br><br>{{< fa "lightbulb" >}} Recommended for a "super-user" who is responsible for managing other users' access to the security dashboards. This permission set does not allow the user to delete user accounts.|

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
---
title: Create App Protect WAF instances for Security Monitoring
description: Learn how to set up F5 NGINX App Protect data plane instances for use with
the NGINX Security Monitoring and NGINX Instance Manager.
toc: true
weight: 100
toc: true
type: how-to
product: NIM
docs: DOCS-1107
---

## Overview

F5 NGINX Security Monitoring supports the following use cases:
The Security Monitoring module supports the following use cases:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd avoid calling Sec Mon a module -- it'll be a feature of NIM 2.19 (automatically installed w/ NIM).


- **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.
- **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.
Expand All @@ -32,7 +30,7 @@ Complete the following prerequisites before proceeding with the steps in this gu
{{< include "nim/tech-specs/security-data-plane-dependencies.md" >}}

1. Determine your use case: **Security Monitoring only** or **Security Monitoring and Configuration Management**.
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" >}}).
1. [Install the Security Monitoring module]({{< relref "/nim/monitoring/security-monitoring/install-security-monitoring.md" >}}) and [upload your license]({{< relref "/nim/admin-guide/license/add-license.md" >}}).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since Sec Mon is installed w/ NIM 2.19, this guide will be removed.

That update is in the docs-1604-decouple-security-monitoring branch, out for review. You might want to rebase to that branch. I also removed the Sec Mon RNs.

Here's the related PR: #86


---

Expand Down Expand Up @@ -199,7 +197,7 @@ Repeat the steps below on each NGINX App Protect WAF data plane instance.
sudo systemctl restart nginx
```

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

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
---
title: Update the geolocation database used in dashboards
description: Learn how to update the Geolocation Database used in F5 NGINX Management
Suite Security Monitoring dashboards.
toc: true
weight: 400
toc: true
type: how-to
product: NIM
docs: DOCS-1108
---

## Overview

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.
You can use the Security Monitoring module 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.

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.

Expand All @@ -21,10 +19,9 @@ By completing the steps in this topic, you will be able to update the Security M

Complete the following prerequisites before proceeding with this guide:

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


---

## Update the geolocation database
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
---
title: Update the Attack Signature Database
description: Learn how to update the Attack Signature Database used in F5 NGINX Management
Suite Security Monitoring dashboards.
toc: true
weight: 300
toc: true
type: how-to
product: NIM
docs: DOCS-1109
---

## Overview

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.
You can use the 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.

Expand All @@ -23,7 +21,7 @@ The steps in this topic ensure that dashboards show the correct information by u

Complete the following prerequisites before proceeding with this guide:

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

---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Install or upgrade Security Monitoring"
title: Install or upgrade Security Monitoring
toc: true
weight: 100
doctype: how-to
Expand All @@ -9,7 +9,7 @@ docs: DOCS-1208

## Overview

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

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Manage WAF Security Policies and Security Log Profiles
description: Learn how to use F5 NGINX Management Suite Instance Manager to manage NGINX
App Protect WAF security policies and security log profiles.
weight: 200
toc: true
type: how-to
Expand All @@ -11,7 +9,7 @@ docs: DOCS-1105

## Overview

F5 NGINX Management Suite Instance Manager provides the ability to manage the configuration of NGINX App Protect WAF instances either by the user interface or the REST API. This includes editing, updating, and deploying security policies, log profiles, attack signatures, and threat campaigns to individual instances and/or instance groups.
F5 Instance Manager provides the ability to manage the configuration of NGINX App Protect WAF instances either by the user interface or the REST API. This includes editing, updating, and deploying security policies, log profiles, attack signatures, and threat campaigns to individual instances and/or instance groups.

In Instance Manager v2.14.0 and later, you can compile a security policy, attack signatures, and threat campaigns into a security policy bundle. A security policy bundle consists of the security policy, the attack signatures, and threat campaigns for a particular version of NGINX App Protect WAF, and additional supporting files that make it possible for NGINX App Protect WAF to use the bundle. Because the security policy bundle is pre-compiled, the configuration gets applied faster than when you individually reference the security policy, attack signature, and threat campaign files.

Expand Down Expand Up @@ -65,7 +63,7 @@ To access the web interface, go to the FQDN for your NGINX Instance Manager host

To create a security policy using the Instance Manager web interface:

1. In a web browser, go to the FQDN for your NGINX Management Suite host and log in. Then, from the Launchpad menu, select **Instance Manager**.
1. In a web browser, go to the FQDN for your NGINX Instance Manager host and log in. Then, from the Launchpad menu, select **Instance Manager**.
2. On the left menu, select **App Protect**.
3. On the *Security Policies* page, select **Create**.
4. On the *Create Policy* page, fill out the necessary fields:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,31 +1,27 @@
---
description: Learn how you can use F5 NGINX Management Suite Instance Manager to configure
NGINX App Protect WAF security policies.
docs: DOCS-992
doctypes:
- reference
tags:
- docs
title: NGINX App Protect WAF configuration management
toc: true
weight: 500
toc: true
type: how-to
product: NIM
docs: DOCS-992
---

## Overview

F5 NGINX Management Suite Instance Manager provides configuration management for [NGINX App Protect WAF](https://www.nginx.com/products/nginx-app-protect/web-application-firewall/).
F5 Instance Manager provides configuration management for [NGINX App Protect WAF](https://www.nginx.com/products/nginx-app-protect/web-application-firewall/).

You can use NGINX App Protect WAF with Instance Manager to inspect incoming traffic, identify potential threats, and block malicious traffic. With Configuration Management for App Protect WAF, you can configure WAF security policies in a single location and push your configurations out to one, some, or all of your NGINX App Protect WAF instances.

### Features

- Manage NGINX App Protect WAF security configurations by using the NGINX Management Suite user interface or REST API
- Manage NGINX App Protect WAF security configurations by using the NGINX Instance Manager user interface or REST API
- Update Attack Signatures and Threat Campaign packages
- Compile security configurations into a binary bundle for consumption by NGINX App Protect WAF instances

## Architecture

As demonstrated in Figure 1, Instance Manager lets you manage security configurations for NGINX App Protect WAF. You can define security policies, upload attack signatures and threat campaign packages, and publish common configurations out to your NGINX App Protect WAF instances. Instance Manager can compile the security configuration into a bundle before pushing the configuration to the NGINX App Protect WAF data plane instances. The NGINX Management Suite Security Monitoring module provides data visualization for NGINX App Protect, so you can monitor, analyze, and refine your policies.
As demonstrated in Figure 1, Instance Manager lets you manage security configurations for NGINX App Protect WAF. You can define security policies, upload attack signatures and threat campaign packages, and publish common configurations out to your NGINX App Protect WAF instances. Instance Manager can compile the security configuration into a bundle before pushing the configuration to the NGINX App Protect WAF data plane instances. The Security Monitoring module provides data visualization for NGINX App Protect, so you can monitor, analyze, and refine your policies.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As demonstrated in Figure 1, Instance Manager lets you manage security configurations for NGINX App Protect WAF. You can define security policies, upload attack signatures and threat campaign packages, and publish common configurations out to your NGINX App Protect WAF instances. Instance Manager can compile the security configuration into a bundle before pushing the configuration to the NGINX App Protect WAF data plane instances. The Security Monitoring module provides data visualization for NGINX App Protect, so you can monitor, analyze, and refine your policies.
As demonstrated in Figure 1, NGINX Instance Manager lets you manage security configurations for NGINX App Protect WAF. You can define security policies, upload attack signatures and threat campaign packages, and publish common configurations out to your NGINX App Protect WAF instances. Instance Manager can compile the security configuration into a bundle before pushing the configuration to the NGINX App Protect WAF data plane instances. The Security Monitoring dashboard provides data visualization for NGINX App Protect, so you can monitor, analyze, and refine your policies.


{{< img src="nim/app-sec-overview.png" caption="Figure 1. NGINX Management Suite with NGINX App Protect Architecture Overview" alt="A diagram showing the architecture of the NGINX Management Suite with NGINX App Protect solution" width="75%">}}

Expand Down
Loading