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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

ADubhlaoich
Copy link
Contributor

Proposed changes

This commit removes mentions of NGINX Management Suite from NGINX Instance Manager documentation, and also clarifies mentions of Security Monitoring as a module. In many cases, due to noun usage, it read as its own separate product, instead of a component.

The frontmatter metadata has also been brought to contemporary standards for all files affected. There are more instances of NMS being mentioned across other products, but they will be addressed as their own discrete PRs for those products, keeping the scope of this one smaller.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • I have updated any relevant documentation (README.md and CHANGELOG.md)
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation.

Please refer to our style guide for guidance about placeholder content.

This commit removes mentions of NGINX Management Suite from NGINX
Instance Manager documentation, and also clarifies mentions of Security
Monitoring as a module. In many cases, due to noun usage, it read as its
own separate product, instead of a component.

The frontmatter metadata has also been brought to contemporary standards
for all files affected. There are more instances of NMS being mentioned
across other products, but they will be addressed as their own discrete
PRs for those products, keeping the scope of this one smaller.
@ADubhlaoich ADubhlaoich requested review from a team as code owners January 29, 2025 17:21
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/140/

---

## 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.

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).

@@ -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

- 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants