feat: Publish NGINX Instance Manager 2.23.0 documentation - #2249
Merged
Conversation
- Add "View NGINX Gateway Fabric security events" concept page under NIM Security Monitoring - Add "Export security logs to F5 NGINX Instance Manager" section to NGF policy-sources.md, under a renamed "Console integration" heading - Add troubleshooting entries for NIM-side and NGF-side event delivery failures - Add a version-requirement pointer to NGF technical specifications - Copy edit policy-sources.md: fix bare "WAF" mentions, correct the garbled NIM heading, split long/passive sentences per style guide Files touched: - content/nim/security-monitoring/ngf-security-events.md (new) - content/nim/security-monitoring/troubleshooting.md - content/ngf/waf-integration/troubleshooting.md - content/ngf/overview/technical-specifications.md - content/ngf/waf-integration/policy-sources.md
…cs into internal/nim-2.23-docs
- Confirm connection scope is security event export only, not F5 WAF policy fetching; state this explicitly in the Overview and remove the now-resolved SME REVIEW comment that flagged it as unconfirmed - Remove the "Create the NGINX Instance Manager dataplane key Secret" section; NGINX Gateway Fabric now reuses the existing nplus-license Secret instead of a separate nim-dp-key Secret - Simplify the Helm install command accordingly: drop --set nginx.nginxInstanceManager.dataplaneKeySecretName=nim-dp-key - Note in "Create the NGINX Plus Secret" that this Secret now also authenticates the NGINX Gateway Fabric to NGINX Instance Manager connection, since it's doing that job in addition to its original purpose - Update f5-summary to match: drop the dataplane-key reference, align first sentence with the Overview's wording - Remove the two pending-change SME REVIEW comments that existed to flag this exact update as outstanding Resolves all three review comments from shaun-nx on PR #316.
…m:nginx/internal-docs into internal/nim-2.23-docs
…cs into internal/nim-2.23-docs
* docs(TECHDOCS-5505): add NGF security event export and visibility - Add "View NGINX Gateway Fabric security events" concept page under NIM Security Monitoring - Add "Export security logs to F5 NGINX Instance Manager" section to NGF policy-sources.md, under a renamed "Console integration" heading - Add troubleshooting entries for NIM-side and NGF-side event delivery failures - Add a version-requirement pointer to NGF technical specifications - Copy edit policy-sources.md: fix bare "WAF" mentions, correct the garbled NIM heading, split long/passive sentences per style guide Files touched: - content/nim/security-monitoring/ngf-security-events.md (new) - content/nim/security-monitoring/troubleshooting.md - content/ngf/waf-integration/troubleshooting.md - content/ngf/overview/technical-specifications.md - content/ngf/waf-integration/policy-sources.md * edits to ngf-security-events.md * added connect-ngf.md topic, copy edits to touched topics. * edits * edits * docs(TECHDOCS-5505): address shaun-nx review on connect-ngf.md - Confirm connection scope is security event export only, not F5 WAF policy fetching; state this explicitly in the Overview and remove the now-resolved SME REVIEW comment that flagged it as unconfirmed - Remove the "Create the NGINX Instance Manager dataplane key Secret" section; NGINX Gateway Fabric now reuses the existing nplus-license Secret instead of a separate nim-dp-key Secret - Simplify the Helm install command accordingly: drop --set nginx.nginxInstanceManager.dataplaneKeySecretName=nim-dp-key - Note in "Create the NGINX Plus Secret" that this Secret now also authenticates the NGINX Gateway Fabric to NGINX Instance Manager connection, since it's doing that job in addition to its original purpose - Update f5-summary to match: drop the dataplane-key reference, align first sentence with the Overview's wording - Remove the two pending-change SME REVIEW comments that existed to flag this exact update as outstanding Resolves all three review comments from shaun-nx on PR #316. * edits per tech review feedback
This reverts commit 119f93e.
This reverts commit 0cb3eb4.
- Add Ubuntu 26.04 LTS support (NIM 2.23.0+, F5 WAF supported) - Split RHEL and Rocky Linux into separate table rows - Add Rocky Linux 10 native package support (2.23.0+) - Clarify Rocky Linux 8.x and 9.x use RHEL compatibility packages Files touched: - content/includes/nim/tech-specs/supported-distros.md
* added 2.23 rns * edits to rns and kis
github-actions
Bot
added
documentation
✅ Deploy Preview will be available once build job completes!
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR publishes the NGINX Instance Manager 2.23.0 documentation, merged from the internal
internal/cherry-pick-nim-2.23-docsbranch.What's new in 2.23.0
New pages
2.23.0 release notes (
content/nim/releases/2.23.0-release-notes.md): Release notes covering new features, resolved issues, and known issues for the 2.23.0 release.Connect NGINX Gateway Fabric to NGINX Instance Manager (
content/nim/connect-kubernetes/connect-ngf.md): New how-to guide covering how to download the NGINX Plus JWT, create the NGINX Plus Secret, and install NGINX Gateway Fabric with the Helm values required to export F5 WAF security events to NGINX Instance Manager.View NGINX Gateway Fabric security events (
content/nim/security-monitoring/ngf-security-events.md): New concept page explaining how NGINX Instance Manager's Security Dashboard now shows F5 WAF security events from NGINX Gateway Fabric deployments via NGINX Agent v3's built-in OpenTelemetry collector.View recent NGINX usage (
content/nim/licensing-and-reporting/view-recent-usage.md): Documents the new Usage Overview page, which provides access to raw, unaggregated usage records from NGINX Plus, NGINX Ingress Controller, and NGINX Gateway Fabric instances. Includes filtering, CSV export, and configurable retention (120 days to 1 year).Updated pages
Tech specs (
content/nim/fundamentals/tech-specs.md,content/includes/nim/tech-specs/supported-distros.md):Known issues (
content/nim/releases/known-issues.md): Updated with new known issues for 2.23.0.Configure policy sources (
content/ngf/waf-integration/policy-sources.md): Adds a new section documenting how to export F5 WAF security logs from NGINX Gateway Fabric to NGINX Instance Manager (requires NIM 2.23+), including theWAFPolicysecurityLogsconfiguration and network requirements.Policy sources troubleshooting (
content/ngf/waf-integration/troubleshooting.md): New troubleshooting entries for the NGINX Gateway Fabric → NGINX Instance Manager security event export integration.NGF technical specifications (
content/ngf/overview/technical-specifications.md): Updated to reflect NGINX Instance Manager 2.23 as the minimum required version for the security event export integration.Security monitoring troubleshooting (
content/nim/security-monitoring/troubleshooting.md): New troubleshooting entries specific to NGINX Gateway Fabric security event visibility in NGINX Instance Manager.