feat: F5 WAF for NGINX 5.9 Refactor (#949)

* feat: F5 WAF for NGINX 5.9 Refactor (#949)

This pull request represents a large amount of documentation changes for F5 WAF for NGINX.

It is the creation of a new documentation set on the path /waf/, replacing /nap-waf: this reflects the change from the product name of NGINX App Protect WAF to F5 WAF for NGINX. The product name itself has also been changed across the entire NGINX documentation website.

Instructions and reference material have been grouped together into high-level use case sections, making it easier for users to navigate and find relevant information. All content moved this way has been rewritten to some extent to match contemporary NGINX writing standards.

The other major change to how documentation is written and structured reflects the new uniform naming conventions for versions, and abolishment of V4 and V5 distinction, instead focusing framing of content and structure of pages around the use case permutation for a deployment.

The historic release notes (Now named the "Changelog" like other NGINX products) have been kept in their previous state for reference. The totality of these changes also include the F5 WAF for NGINX 5.9 release, which has early availability features.

Author: ADubhlaoich

.github/CODEOWNERS

@@ -22,10 +22,10 @@
 # NGINX Agent
 content/nginx/nms/agent/*   @nginx/nginx-agent 
 
-# NGINX App Protect DoS
+# F5 DoS for NGINX
 content/nap-dos/*           @nginx/dos-docs-approvers
 
-# NGINX App Protect WAF
+# F5 WAF for NGINX
 content/nap-waf/*           @nginx/nap-docs-approvers
 data/nap-waf/*              @nginx/nap-docs-approvers
 

_banners/waf-early-availability.md

@@ -0,0 +1,5 @@
+{{< banner "warning" "Early availability feature" >}}
+
+This functionality is available as an early availability feature in the latest release.
+
+{{< /banner >}}

_banners/waf-unification-notice.md

@@ -0,0 +1,7 @@
+{{< banner "note" "Documentation changes" >}}
+
+Welcome to the F5 WAF for NGINX documentation! This product was formerly known as NGINX App Protect WAF.
+
+Documentation is being incrementally rewritten: if you're looking for information that hasn't been re-integrated yet, you can still browse [the old documentation]({{< ref "/nap-waf" >}}).
+
+{{< /banner >}}

_banners/waf-virtual-restriction.md

@@ -0,0 +1,7 @@
+{{< banner "note" "NGINX version restriction" >}}
+
+For a virtual machine or bare metal installation, only NGINX Plus is available.
+
+If you would like to use NGINX Open Source, you should follow [Docker]({{< ref "/waf/install/docker.md" >}}) or [Kubernetes]({{< ref "/waf/install/kubernetes.md" >}}) instructions.
+
+{{< /banner >}}

cloudcannon.config.yml

@@ -88,8 +88,8 @@ collections_config:
   nap_dos:
     path: content/nap-dos
     output: true
-    name: NGINX App Protect DoS
-    description: Documentation for NGINX App Protect DoS
+    name: F5 DoS for NGINX
+    description: Documentation for F5 DoS for NGINX
     parse_branch_index: false
     icon: notes
     preview:
@@ -132,8 +132,8 @@ collections_config:
   nap_waf:
     path: content/nap-waf
     output: true
-    name: NGINX App Protect WAF
-    description: Documentation for NGINX App Protect WAF.
+    name: F5 WAF for NGINX
+    description: Documentation for F5 WAF for NGINX.
     parse_branch_index: false
     icon: notes
     preview:

config/_default/config.toml

@@ -20,6 +20,7 @@ enableGitInfo = true
   nim = '/nginx-instance-manager/:sections[1:]/:contentbasename'
   nms = '/nginx-management-suite/:sections[1:]/:contentbasename'
   unit = '/nginx-unit/:sections[1:]/:contentbasename'
+  waf = '/waf/:sections[1:]/:contentbasename'
 
 [caches]
   [caches.modules]

content/_index.md

@@ -33,11 +33,11 @@ Learn how to deliver, manage, and protect your applications using F5 NGINX produ
   {{</card >}}
 {{</card-section>}}
 
-{{<card-section showAsCards="true" title="F5 NGINX App Protect">}}
-  {{<card title="F5 NGINX App Protect WAF" titleUrl="/nginx-app-protect-waf/" brandIcon="NGINX-App-Protect-WAF-product-icon.svg" isLanding="true">}}
+{{<card-section showAsCards="true" title="F5 WAF for NGINX">}}
+  {{<card title="F5 WAF for NGINX" titleUrl="/waf/" brandIcon="NGINX-App-Protect-WAF-product-icon.svg" isLanding="true">}}
     Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs.
   {{</card >}}
-  {{<card title="F5 NGINX App Protect DoS" titleUrl="/nginx-app-protect-dos/" brandIcon="NGINX-App-Protect-DoS-product-icon.svg" isLanding="true">}}
+  {{<card title="F5 DoS for NGINX" titleUrl="/nginx-app-protect-dos/" brandIcon="NGINX-App-Protect-DoS-product-icon.svg" isLanding="true">}}
     Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.
   {{</card >}}
 {{</card-section>}}

content/controller/admin-guides/install/install-for-controller.md

@@ -1,8 +1,8 @@
 ---
-description: Take the steps in this guide to deploy F5 NGINX App Protect WAF as a
+description: Take the steps in this guide to deploy F5 WAF for NGINX as a
   datapath instance for use with NGINX Controller.
 nd-docs: DOCS-645
-title: Using NGINX App Protect WAF with NGINX Controller
+title: Using F5 WAF for NGINX with NGINX Controller
 toc: true
 weight: 500
 type:
@@ -13,12 +13,12 @@ type:
 
 ## Setup
 
-Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/admin-guide/install#prerequisites" >}}), [Platform Security Considerations]({{< ref "/nap-waf/v4/admin-guide/install#platform-security-considerations" >}}) and [User Permissions]({{< ref "/nap-waf/v4/admin-guide/install#user-permissions" >}}) sections of the NGINX App Protect WAF Admin Guide.
+Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/admin-guide/install#prerequisites" >}}), [Platform Security Considerations]({{< ref "/nap-waf/v4/admin-guide/install#platform-security-considerations" >}}) and [User Permissions]({{< ref "/nap-waf/v4/admin-guide/install#user-permissions" >}}) sections of the F5 WAF for NGINX Admin Guide.
 
 
-## Install NGINX App Protect WAF
+## Install F5 WAF for NGINX
 
-**Note:** If a version of NGINX App Protect WAF prior to 3.6 is required, please contact the NGINX Sales team to assist with this configuration.
+**Note:** If a version of F5 WAF for NGINX prior to 3.6 is required, please contact the NGINX Sales team to assist with this configuration.
 
 {{<tabs name="install-nap-waf">}}
 
@@ -66,19 +66,19 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/nginx-plus-7.4.repo
    ```
 
-8. Add NGINX App Protect WAF repository by downloading the file app-protect-7.repo to /etc/yum.repos.d:
+8. Add F5 WAF for NGINX repository by downloading the file app-protect-7.repo to /etc/yum.repos.d:
 
    ```shell
    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/app-protect-7.repo
    ```
 
-9. If NGINX Plus or NGINX App Protect WAF was previously installed on the system, clean up package manager cache information:
+9. If NGINX Plus or F5 WAF for NGINX was previously installed on the system, clean up package manager cache information:
 
    ```shell
    sudo yum clean all
    ```
 
-10. Install the latest NGINX App Protect WAF package.
+10. Install the latest F5 WAF for NGINX package.
 
       **See Also:** Please refer to [NGINX App Protect Compatibility Matrix]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#nginx-app-protect-compatibility-matrix" >}}) for specific version compatibility.
 
@@ -94,7 +94,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
       sudo nginx -v
       ```
 
-12. Configure SELinux as appropriate per your organization’s security policies. NGINX App Protect WAF applies the prebuilt SELinux policy module during the installation. If you encounter any issues, check the [Troubleshooting Guide]({{< ref "/nap-waf/v4/troubleshooting-guide/troubleshooting#selinux" >}}).
+12. Configure SELinux as appropriate per your organization’s security policies. F5 WAF for NGINX applies the prebuilt SELinux policy module during the installation. If you encounter any issues, check the [Troubleshooting Guide]({{< ref "/nap-waf/v4/troubleshooting-guide/troubleshooting#selinux" >}}).
 
       **Note:** NGINX Controller has specific [requirements regarding SELinux configuration]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#supported-distributions" >}}).
 
@@ -171,7 +171,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/nginx-plus-7.4.repo
    ```
 
-8. Add NGINX App Protect WAF repository by downloading the file app-protect-7.repo to /etc/yum.repos.d:
+8. Add F5 WAF for NGINX repository by downloading the file app-protect-7.repo to /etc/yum.repos.d:
 
    ```shell
    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/app-protect-7.repo
@@ -204,13 +204,13 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
       gpgkey=http://ftp.heanet.ie/pub/centos/7/os/x86_64/RPM-GPG-KEY-CentOS-7
       ```
 
-10. If NGINX Plus or NGINX App Protect WAF was previously installed on the system, clean up package manager cache information:
+10. If NGINX Plus or F5 WAF for NGINX was previously installed on the system, clean up package manager cache information:
 
     ```shell
     sudo yum clean all
     ```
 
-11. Install the latest NGINX App Protect WAF package.
+11. Install the latest F5 WAF for NGINX package.
 
       **See Also:** Please refer to [NGINX App Protect Compatibility Matrix]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#nginx-app-protect-compatibility-matrix" >}}) for specific version compatibility.
 
@@ -226,7 +226,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
       sudo nginx -v
       ```
 
-13. Configure SELinux as appropriate per your organization’s security policies. NGINX App Protect WAF applies the prebuilt SELinux policy module during the installation. If you encounter any issues, check the [Troubleshooting Guide]({{< ref "/nap-waf/v4/troubleshooting-guide/troubleshooting#selinux" >}}).
+13. Configure SELinux as appropriate per your organization’s security policies. F5 WAF for NGINX applies the prebuilt SELinux policy module during the installation. If you encounter any issues, check the [Troubleshooting Guide]({{< ref "/nap-waf/v4/troubleshooting-guide/troubleshooting#selinux" >}}).
 
       **Note:** NGINX Controller has specific [requirements regarding SELinux configuration]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#supported-distributions" >}}).
 
@@ -263,7 +263,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
 
 {{%tab name="Debian"%}}
 
-**Note:** As of NGINX Plus R24, support for Debian 9 is no longer available. As a consequence, NGINX App Protect WAF 3.1 is the final version available for this operating system version.
+**Note:** As of NGINX Plus R24, support for Debian 9 is no longer available. As a consequence, F5 WAF for NGINX 3.1 is the final version available for this operating system version.
 
 1. If you already have NGINX packages in your system, back up your configs and logs:
 
@@ -312,7 +312,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
    printf "deb https://pkgs.nginx.com/plus/debian `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nginx-plus.list
    ```
 
-9. Add NGINX App Protect WAF repository:
+9. Add F5 WAF for NGINX repository:
 
    ```shell
    printf "deb https://pkgs.nginx.com/app-protect/debian `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nginx-app-protect.list
@@ -324,7 +324,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
     sudo wget -P /etc/apt/apt.conf.d https://cs.nginx.com/static/files/90pkgs-nginx
     ```
 
-11. Update the repository and install the lastest supported NGINX App Protect WAF packages.
+11. Update the repository and install the lastest supported F5 WAF for NGINX packages.
 
       **See Also:** Please refer to [NGINX App Protect Compatibility Matrix]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#nginx-app-protect-compatibility-matrix" >}}) for specific version compatibility.
 
@@ -430,7 +430,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
    printf "deb https://pkgs.nginx.com/plus/ubuntu `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nginx-plus.list
    ```
 
-9. Add NGINX App Protect WAF repository:
+9. Add F5 WAF for NGINX repository:
 
    ```shell
    printf "deb https://pkgs.nginx.com/app-protect/ubuntu `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nginx-app-protect.list
@@ -442,7 +442,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
       sudo wget -P /etc/apt/apt.conf.d https://cs.nginx.com/static/files/90pkgs-nginx
       ```
 
-11. Update the repository and install the latest App Protect WAF package.
+11. Update the repository and install the latest F5 WAF for NGINX package.
 
       **See Also:** Please refer to [NGINX App Protect Compatibility Matrix]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#nginx-app-protect-compatibility-matrix" >}}) for specific version compatibility.
 
@@ -497,34 +497,34 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
 
 16. To upgrade your signature package to the latest version and obtain the best protection, refer to [Updating App Protect Attack Signatures]({{< ref "/nap-waf/v4/admin-guide/install#ubuntu-1804" >}}).
 
-   **Note:** Ubuntu 20.04 activates **AppArmor** by default, but NGINX App Protect WAF will run in unconfined mode after being installed as it is shipped with no AppArmor profile. To benefit from AppArmor access control capabilities for NGINX App Protect WAF, you will have to write your own AppArmor profile for NGINX App Protect WAF executables found in `/opt/app_protect/bin` such that it best suits your environment.
+   **Note:** Ubuntu 20.04 activates **AppArmor** by default, but F5 WAF for NGINX will run in unconfined mode after being installed as it is shipped with no AppArmor profile. To benefit from AppArmor access control capabilities for F5 WAF for NGINX, you will have to write your own AppArmor profile for F5 WAF for NGINX executables found in `/opt/app_protect/bin` such that it best suits your environment.
 
 {{%/tab%}}
 
 {{%tab name="Amazon Linux 2 LTS"%}}
 
-Using NGINX App Protect WAF with NGINX Controller isn't supported on Amazon Linux 2 LTS.
+Using F5 WAF for NGINX with NGINX Controller isn't supported on Amazon Linux 2 LTS.
 
 {{%/tab%}}
 
 {{%tab name="Alpine"%}}
 
-Using NGINX App Protect WAF with NGINX Controller isn't supported on Alpine.
+Using F5 WAF for NGINX with NGINX Controller isn't supported on Alpine.
 
 {{%/tab%}}
 {{</tabs>}}
 
 <hr>
 
-## Add NGINX App Protect WAF to NGINX Controller
+## Add F5 WAF for NGINX to NGINX Controller
 
-If this NGINX Plus instance is already managed by Controller, [restart the Agent]({{< ref "/controller/admin-guides/install/agent-restart" >}}) after NGINX App Protect WAF is installed.
+If this NGINX Plus instance is already managed by Controller, [restart the Agent]({{< ref "/controller/admin-guides/install/agent-restart" >}}) after F5 WAF for NGINX is installed.
 
-Otherwise, complete the tasks in the NGINX Controller [Add an NGINX App Protect WAF Instance]({{< ref "/controller/infrastructure/instances/add-nap-instance.md#add-the-nginx-app-protect-instance" >}}) guide.
+Otherwise, complete the tasks in the NGINX Controller [Add an F5 WAF for NGINX Instance]({{< ref "/controller/infrastructure/instances/add-nap-instance.md#add-the-nginx-app-protect-instance" >}}) guide.
 
-## Use NGINX App Protect WAF with NGINX Controller
+## Use F5 WAF for NGINX with NGINX Controller
 
-**Note:** When configuring NGINX App Protect WAF as a datapath instance for NGINX Controller, **you should not modify the `nginx.conf` file**. The `nginx.conf` file will be automatically updated when enabling WAF on a Component in NGINX Controller.
+**Note:** When configuring F5 WAF for NGINX as a datapath instance for NGINX Controller, **you should not modify the `nginx.conf` file**. The `nginx.conf` file will be automatically updated when enabling WAF on a Component in NGINX Controller.
 
 Refer to the following NGINX Controller user guides for further information about how to secure your apps and/or APIs with NGINX Controller:
 

content/controller/app-delivery/about-snippets.md

@@ -557,7 +557,7 @@ The `reuseport` parameter creates an individual listening socket for each worker
 
 ## Extend App Security with Snippets
 
-When adding [NGINX Controller App Security]({{< ref "add-app-security-with-waf" >}}) to your components, you can use Snippets to add NGINX App Protect directives that aren't represented in the NGINX Controller API. You can also use Snippets to [tune your NGINX App Protect WAF performance]({{< ref "/controller/app-delivery/security/tutorials/tune-waf-for-app" >}}).
+When adding [NGINX Controller App Security]({{< ref "add-app-security-with-waf" >}}) to your components, you can use Snippets to add NGINX App Protect directives that aren't represented in the NGINX Controller API. You can also use Snippets to [tune your F5 WAF for NGINX performance]({{< ref "/controller/app-delivery/security/tutorials/tune-waf-for-app" >}}).
 
 Refer to [Extend App Security with Snippets]({{< ref "extend-app-security-snippets" >}}) for more information and examples.