Skip to content

feat: F5 dos for nginx 4.9#1863

Merged
JTorreG merged 25 commits into
mainfrom
nap-dos-4.9
May 13, 2026
Merged

feat: F5 dos for nginx 4.9#1863
JTorreG merged 25 commits into
mainfrom
nap-dos-4.9

Conversation

@rnitzan
Copy link
Copy Markdown
Contributor

@rnitzan rnitzan commented Apr 19, 2026

Proposed changes

F5 Dos for NGINX v4.9 release over NGINX Plus R37

  • Align with NGINX Plus R37
  • Adding RHEL 10 support
  • Adding Debian 13 support
  • Docker and k8s documentation update

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@github-actions github-actions Bot added documentation Improvements or additions to documentation product/dos Issues related to F5 DoS for NGINX labels Apr 19, 2026
@github-actions
Copy link
Copy Markdown

Deploy Preview will be available once build job completes!

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

rnitzan and others added 8 commits April 19, 2026 12:28
…ent (#1871)

* added Google site verification file for Google Search Console enablement

* moved to /static

---------

Co-authored-by: Lam Nguyen <la.nguyen@f5.com>
)

* Add instructions that shows a user how update an existing license

* Minor change to kubectl param

* Correct param
…r security monitoring (#1861)

* docs(nginx-one): improve security monitoring setup verification

-  Clarify where to place the secops_dashboard logging directives in the NGINX
  configuration and expand the verification flow into a concrete end-to-end
  check using the Security Dashboard Event Logs tab.

- Add labeled example test requests for common attack patterns (XSS, path
  traversal, SQL injection) so operators can generate sample security events
  while setting up the default blocking policy. Document that customized or
  transparent policies may alert instead of block.

* docs(nginx-one): add local security monitoring troubleshooting guide

- Add a new local data plane troubleshooting guide for NGINX One security
  monitoring to help customers diagnose why F5 WAF for NGINX security events
  do not appear in the dashboard after setup.

- The new guide covers four checks:
  - invalid secops_dashboard log profile errors in the embedded collector log
  - port 1514 ownership for local syslog delivery
  - presence of the generated security log pipeline in the collector config
  - optional debug exporter configuration for collector-side verification

  Also update the main security monitoring setup guide to improve verification,
  add labeled example attack requests for generating test events, and link to
  the new troubleshooting workflow. Update the section landing page so the new
  guide is discoverable from the security monitoring docs.

* Update content/nginx-one-console/waf-integration/waf-security-dashboard/local-dataplane-troubleshooting.md

Update as recommended

Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com>

---------

Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com>
@github-actions github-actions Bot added product/nic Issues related to NGINX Ingress Controller product/nginx-one-console Issues related to NGINX One Console labels Apr 23, 2026
@rnitzan rnitzan marked this pull request as ready for review April 23, 2026 11:03
@rnitzan rnitzan requested a review from a team as a code owner April 23, 2026 11:03
Comment thread content/includes/dos/dos-arbitrator.md Outdated
Comment thread content/nap-dos/deployment-guide/kubernetes.md
Comment thread content/includes/dos/dos-arbitrator.md
Comment thread content/includes/dos/dockerfiles/alpine-ebpf-manager.md
Comment thread content/includes/dos/dos-entrypoint.md Outdated
Comment thread content/includes/dos/dos-waf-entrypoint.md Outdated
Comment thread content/includes/dos/install-post-checks.md Outdated
Comment thread content/nap-dos/deployment-guide/kubernetes.md Outdated
Comment thread content/nap-dos/deployment-guide/kubernetes.md Outdated
Comment thread content/nap-dos/deployment-guide/kubernetes.md Outdated
Comment thread content/nap-dos/deployment-guide/kubernetes.md
Comment thread content/nap-dos/deployment-guide/kubernetes.md Outdated
@travisamartin travisamartin mentioned this pull request Apr 30, 2026
3 tasks
Comment thread content/includes/dos/k8s_arbitrator/appprotect-dos-arb.md Outdated
Comment thread content/includes/dos/k8s_arbitrator/svc-appprotect-dos-arb.md Outdated
@travisamartin
Copy link
Copy Markdown
Contributor

@rnitzan -- I opened a PR w/ my suggested edits. Take a look: #1905

Copy link
Copy Markdown
Contributor

@travisamartin travisamartin left a comment

Choose a reason for hiding this comment

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

Looks like some includes were added that aren't actually used.

One filename has two .. for the extension and should be renamed.

I had the Tech Writer agent add the requested metadata and do a copy edit on the new and touched files. Since there are a lot of suggested edits, I opened a new PR targeting this one. Take a look: #1905

rnitzan and others added 2 commits May 4, 2026 12:21
- Add missing front matter: description, keywords, nd-summary
- Fix sentence case: 'Post-installation checks', 'F5 DoS for NGINX arbitrator'
- Fix 'should' → 'must' for JWT token and image repository requirements

Addresses review comments from JTorreG on PR #1863.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rnitzan
Copy link
Copy Markdown
Contributor Author

rnitzan commented May 4, 2026

@rnitzan on top of 2 technical writer approvals for the prose content, we will also need a review and approval from an engineer to confirm that all the dockerfiles have been tested and are correct. Thank you.

Hi @JTorreG
I'm the F5 Dos for Nginx engineer who tested those dockerfile and they are correct

@rnitzan rnitzan requested review from JTorreG, mjang and travisamartin May 7, 2026 11:10
travisamartin and others added 8 commits May 7, 2026 07:55
* docs(nap-dos): fix product names, metadata, and prose quality for 4.9 release

* docs(nap-dos): prose edit pass on 4.9 release files

- Fix product names throughout: 'App Protect DoS' and 'F5 DOS for NGINX'
  replaced with correct 'F5 DoS for NGINX'
- Fix 'pre-requisites' → 'prerequisites', '(Purchased or trial)' → lowercase
- Remove first-person voice ('We will configure')
- Replace 'i.e.' with 'for example' throughout
- Fix grammar: 'Bugs fixing' → 'Bug fixes', 'prob.' → 'probe', 'its' → 'it is'
- Replace inline HTML (<br>, <span style=...>) with Markdown equivalents
- Replace hard-coded external links with internal ref shortcodes
- Fix 'Click' → 'Select' per style guide
- Fix heading levels: # Overview → ## Overview in license-secret.md
- Remove weak lead sentence ('This document explains...')
- Fix 'cannot' (was 'can not'), add missing Oxford comma
- Clean up trailing <br> tags from end-of-sentence positions
- Fix double space before 'In offline environments'

* chore: remove .style-guide submodule from PR

* docs(nap-dos): restore eBPF acronym expansion in best-practices

* docs(nap-dos): expand acronyms on first mention, fix remaining prose issues

- types-of-logs.md: rewrite Request Log section (missed in previous pass) —
  fix 'App Protect DoS' x3, 'In order to', heading capitalisation, <br> tags
- installing...aws.md: remove last <span> HTML tag in step 4
- learn-about-deployment.md: fix remaining 'App Protect DoS' product name
- troubleshoot.md: expand XFF (X-Forwarded-For); expand ELK on first mention
- kubernetes-with-L4...md: expand eBPF (Extended Berkeley Packet Filter) on
  first mention in prose
- dos-arbitrator.md: expand FQDN (fully qualified domain name); expand mTLS
  (mutual TLS) on first mention
- learn-about-directives-and-policy.md: expand FQDN on first prose mention

* chore: remove .style-guide submodule from PR (again)

* Revisions to expanded acronyms

* fix(nic): update broken ref to subscription licenses topic

The /solutions/about-subscription-licenses.md file was reorganized into
a subdirectory. Update the ref to the correct path and anchor:
/solutions/about-subscription-licenses/getting-started.md#internet-connected

* chore(includes/dos): clean up front matter in dos includes

- Add nd-product: F5DOSN to dos-arbitrator.md and install-post-checks.md
- Add missing learn-about-deployment.md to dos-arbitrator.md nd-files list
- Remove invalid nd-docs: null from both files

* chore(includes/dos): add nd-product and nd-files front matter to all dos includes

- Add nd-product: F5DOSN to all includes missing it
- Add nd-files lists based on actual include usage in content files
- Remove invalid nd-docs: null from dos-entrypoint.md and dos-waf-entrypoint.md
- Fix dos-waf-entrypoint.md nd-files: only used in learn-about-deployment.md
- k8s_arbitrator files: nd-product only (not yet referenced in content)
- Replace hardcoded syslog IP 10.197.30.219:5261 with <syslog-server-ip>:<port>
  placeholder in k8s_manifest and k8s_with_ebpf_manifest nginx-conf-configmap files

* fix(nap-dos): replace internal IP addresses with placeholders

Replace non-RFC-5737 example IP 10.197.30.219 (and typo 10.97.30.219)
with <SYSLOG_SERVER_IP> placeholder per sensitive-information.md guidance.

Affected files:
- content/includes/dos/k8s_manifest/dos-nginx-conf-configmap.md
- content/includes/dos/k8s_with_ebpf_manifest/dos-nginx-conf-configmap.md
- content/nap-dos/deployment-guide/best-practices.md (2 occurrences)

* fix(nap-dos): fix mixed named/positional call-out shortcode params

* chore(nap-dos): add nd-summary and expand short descriptions

* chore: remove unused k8s_arbitrator include files

The appprotect-dos-arb.md and svc-appprotect-dos-arb.md include files
in content/includes/dos/k8s_arbitrator/ are not referenced by any
page via the include shortcode, so they serve no purpose.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore(nap-dos): remove Helm install path and fix double-dot filename

- Remove the 'Use Helm to install' sections from kubernetes.md and
  kubernetes-with-L4-accelerated-mitigation.md; only the manifest-based
  install path remains
- Update front matter (description, keywords, nd-summary) to drop all
  Helm references in both files
- Rename kubernetes-with-L4-accelerated-mitigation..md (double dot) to
  kubernetes-with-L4-accelerated-mitigation.md (single dot)
- Update nd-files references in 18 include files under
  content/includes/dos/ to point to the corrected filename

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: r.nitzan@f5.com <r.nitzan@f5.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Raanan <59834489+rnitzan@users.noreply.github.com>
Updated release date for version 4.9 and added NGINX Plus R37 support.
Co-authored-by: Jon Torre <78599298+JTorreG@users.noreply.github.com>
Co-authored-by: Jon Torre <78599298+JTorreG@users.noreply.github.com>
Co-authored-by: Jon Torre <78599298+JTorreG@users.noreply.github.com>
…section, fix typos

- Add nd-files metadata to 8 dockerfile includes missing it
- Delete unused rocky9-plus-dos-waf.md include
- Remove Helm installation section (Helm support dropped)
- Fix typos in manifest section (enviorment, anmae)
- Fix Post-installation checks section (typos, incomplete sentence)
Resolve conflicts: rename nd-* metadata keys to f5-* prefix to align
with main branch convention. Keep branch content and f5-files metadata.
@rnitzan
Copy link
Copy Markdown
Contributor Author

rnitzan commented May 13, 2026

Hi @JTorreG @travisamartin @mjang
please review
F5 Dos for NGINX version 4.9 is going live today with NGINX R37.0.0

@travisamartin travisamartin dismissed their stale review May 13, 2026 15:57

edits incorporated

@travisamartin travisamartin dismissed mjang’s stale review May 13, 2026 15:58

edits incorporated

@JTorreG JTorreG merged commit 865aa71 into main May 13, 2026
9 checks passed
@JTorreG JTorreG deleted the nap-dos-4.9 branch May 13, 2026 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/dos Issues related to F5 DoS for NGINX product/nginx-one-console Issues related to NGINX One Console product/nic Issues related to NGINX Ingress Controller

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants