Skip to content

Update WAF v5 docs for v4.1.0 release #7566

@shaun-nx

Description

@shaun-nx

Overview

As a user of NGINX App Protect WAF and NGINX Ingress Controller
I want clarity around what NGINX App Protect WAF is capable of
So I can use it without confusion

Details

This request comes from Aviv Dahan, the PM for NGINX App Protect WAF:

"F5 recommends compiling/recompiling your NGINX AppProtect WAF Policy Bundles"- A bundle itself isn't compiled; rather, you compile a policy, which then generates a bundle.
i found it confusing, users might not understand that the intention is for JSON policies.

We are stating an irrelevant limitation that adds operational complexity “F5 recommends compiling ...with each release of NGINX Ingress Controller”. This limitation should be removed.
The note feels more oriented with 'upgrade' procedure (it mentions 'with each release') rather on fresh deployment.
Instead, i would expect to see it under the 'Enable NGINX App Protect WAF v5' section, with clear steps to eliminate confusion.

This feedback concerns the NGINX App Protect WAF V5 section.

Tasks

  • Update the WAF v5 documentation to highlight that policies no longer require recompilation during upgrade after NIC 4.1
  • Remove the word "bundle" from documentation, which creates ambiguity around the policies
  • Add or move the steps to compile/recompile a bundle under the "Enable NGINX App Protect WAF v5" section
  • Check if any of the changes should also affect the v4 documentation

Acceptance criteria

  • The user has clarity on what F5 recommends as standard practice
  • The user understands what limitations exist for the software
  • The user is presented important information at the contextually appropriate time

Metadata

Metadata

Labels

documentationPull requests/issues for documentationproposalAn issue that proposes a feature request

Type

Projects

Status

Done 🚀

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions