Skip to content

Commit d7465f8

Browse files
authored
Merge branch 'main' into revamp-spec-summary-table
2 parents fad2320 + c981ad0 commit d7465f8

File tree

280 files changed

+19272
-869
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

280 files changed

+19272
-869
lines changed

.github/CODEOWNERS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222
# NGINX Agent
2323
content/nginx/nms/agent/* @nginx/nginx-agent
2424

25-
# NGINX App Protect DoS
25+
# F5 DoS for NGINX
2626
content/nap-dos/* @nginx/dos-docs-approvers
2727

28-
# NGINX App Protect WAF
28+
# F5 WAF for NGINX
2929
content/nap-waf/* @nginx/nap-docs-approvers
3030
data/nap-waf/* @nginx/nap-docs-approvers
3131

_banners/waf-early-availability.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{{< banner "warning" "Early availability feature" >}}
2+
3+
This functionality is available as an early availability feature in the latest release.
4+
5+
{{< /banner >}}

_banners/waf-unification-notice.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{{< banner "note" "Documentation changes" >}}
2+
3+
Welcome to the F5 WAF for NGINX documentation! This product was formerly known as NGINX App Protect WAF.
4+
5+
{{< /banner >}}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{{< banner "note" "NGINX version restriction" >}}
2+
3+
For a virtual machine or bare metal installation, only NGINX Plus is available.
4+
5+
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.
6+
7+
{{< /banner >}}

cloudcannon.config.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ collections_config:
8888
nap_dos:
8989
path: content/nap-dos
9090
output: true
91-
name: NGINX App Protect DoS
92-
description: Documentation for NGINX App Protect DoS
91+
name: F5 DoS for NGINX
92+
description: Documentation for F5 DoS for NGINX
9393
parse_branch_index: false
9494
icon: notes
9595
preview:
@@ -132,8 +132,8 @@ collections_config:
132132
nap_waf:
133133
path: content/nap-waf
134134
output: true
135-
name: NGINX App Protect WAF
136-
description: Documentation for NGINX App Protect WAF.
135+
name: F5 WAF for NGINX
136+
description: Documentation for F5 WAF for NGINX.
137137
parse_branch_index: false
138138
icon: notes
139139
preview:

config/_default/config.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ enableGitInfo = true
2020
nim = '/nginx-instance-manager/:sections[1:]/:contentbasename'
2121
nms = '/nginx-management-suite/:sections[1:]/:contentbasename'
2222
unit = '/nginx-unit/:sections[1:]/:contentbasename'
23+
waf = '/waf/:sections[1:]/:contentbasename'
2324

2425
[caches]
2526
[caches.modules]

content/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ Learn how to deliver, manage, and protect your applications using F5 NGINX produ
3333
{{</card >}}
3434
{{</card-section>}}
3535

36-
{{<card-section showAsCards="true" title="F5 NGINX App Protect">}}
37-
{{<card title="F5 NGINX App Protect WAF" titleUrl="/nginx-app-protect-waf/" brandIcon="NGINX-App-Protect-WAF-product-icon.svg" isLanding="true">}}
36+
{{<card-section showAsCards="true" title="F5 WAF for NGINX">}}
37+
{{<card title="F5 WAF for NGINX" titleUrl="/waf/" brandIcon="NGINX-App-Protect-WAF-product-icon.svg" isLanding="true">}}
3838
Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs.
3939
{{</card >}}
40-
{{<card title="F5 NGINX App Protect DoS" titleUrl="/nginx-app-protect-dos/" brandIcon="NGINX-App-Protect-DoS-product-icon.svg" isLanding="true">}}
40+
{{<card title="F5 DoS for NGINX" titleUrl="/nginx-app-protect-dos/" brandIcon="NGINX-App-Protect-DoS-product-icon.svg" isLanding="true">}}
4141
Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.
4242
{{</card >}}
4343
{{</card-section>}}

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

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
description: Take the steps in this guide to deploy F5 NGINX App Protect WAF as a
2+
description: Take the steps in this guide to deploy F5 WAF for NGINX as a
33
datapath instance for use with NGINX Controller.
44
nd-docs: DOCS-645
5-
title: Using NGINX App Protect WAF with NGINX Controller
5+
title: Using F5 WAF for NGINX with NGINX Controller
66
toc: true
77
weight: 500
88
type:
@@ -13,12 +13,12 @@ type:
1313

1414
## Setup
1515

16-
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.
16+
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.
1717

1818

19-
## Install NGINX App Protect WAF
19+
## Install F5 WAF for NGINX
2020

21-
**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.
21+
**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.
2222

2323
{{<tabs name="install-nap-waf">}}
2424

@@ -66,19 +66,19 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
6666
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/nginx-plus-7.4.repo
6767
```
6868

69-
8. Add NGINX App Protect WAF repository by downloading the file app-protect-7.repo to /etc/yum.repos.d:
69+
8. Add F5 WAF for NGINX repository by downloading the file app-protect-7.repo to /etc/yum.repos.d:
7070

7171
```shell
7272
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/app-protect-7.repo
7373
```
7474

75-
9. If NGINX Plus or NGINX App Protect WAF was previously installed on the system, clean up package manager cache information:
75+
9. If NGINX Plus or F5 WAF for NGINX was previously installed on the system, clean up package manager cache information:
7676

7777
```shell
7878
sudo yum clean all
7979
```
8080

81-
10. Install the latest NGINX App Protect WAF package.
81+
10. Install the latest F5 WAF for NGINX package.
8282

8383
**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.
8484

@@ -94,7 +94,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
9494
sudo nginx -v
9595
```
9696

97-
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" >}}).
97+
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" >}}).
9898

9999
**Note:** NGINX Controller has specific [requirements regarding SELinux configuration]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#supported-distributions" >}}).
100100

@@ -171,7 +171,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
171171
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/nginx-plus-7.4.repo
172172
```
173173

174-
8. Add NGINX App Protect WAF repository by downloading the file app-protect-7.repo to /etc/yum.repos.d:
174+
8. Add F5 WAF for NGINX repository by downloading the file app-protect-7.repo to /etc/yum.repos.d:
175175

176176
```shell
177177
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
204204
gpgkey=http://ftp.heanet.ie/pub/centos/7/os/x86_64/RPM-GPG-KEY-CentOS-7
205205
```
206206
207-
10. If NGINX Plus or NGINX App Protect WAF was previously installed on the system, clean up package manager cache information:
207+
10. If NGINX Plus or F5 WAF for NGINX was previously installed on the system, clean up package manager cache information:
208208
209209
```shell
210210
sudo yum clean all
211211
```
212212
213-
11. Install the latest NGINX App Protect WAF package.
213+
11. Install the latest F5 WAF for NGINX package.
214214
215215
**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.
216216
@@ -226,7 +226,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
226226
sudo nginx -v
227227
```
228228
229-
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" >}}).
229+
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" >}}).
230230
231231
**Note:** NGINX Controller has specific [requirements regarding SELinux configuration]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#supported-distributions" >}}).
232232
@@ -263,7 +263,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
263263
264264
{{%tab name="Debian"%}}
265265
266-
**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.
266+
**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.
267267
268268
1. If you already have NGINX packages in your system, back up your configs and logs:
269269
@@ -312,7 +312,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
312312
printf "deb https://pkgs.nginx.com/plus/debian `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nginx-plus.list
313313
```
314314
315-
9. Add NGINX App Protect WAF repository:
315+
9. Add F5 WAF for NGINX repository:
316316
317317
```shell
318318
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
324324
sudo wget -P /etc/apt/apt.conf.d https://cs.nginx.com/static/files/90pkgs-nginx
325325
```
326326
327-
11. Update the repository and install the lastest supported NGINX App Protect WAF packages.
327+
11. Update the repository and install the lastest supported F5 WAF for NGINX packages.
328328
329329
**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.
330330
@@ -430,7 +430,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
430430
printf "deb https://pkgs.nginx.com/plus/ubuntu `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nginx-plus.list
431431
```
432432
433-
9. Add NGINX App Protect WAF repository:
433+
9. Add F5 WAF for NGINX repository:
434434
435435
```shell
436436
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
442442
sudo wget -P /etc/apt/apt.conf.d https://cs.nginx.com/static/files/90pkgs-nginx
443443
```
444444
445-
11. Update the repository and install the latest App Protect WAF package.
445+
11. Update the repository and install the latest F5 WAF for NGINX package.
446446
447447
**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.
448448
@@ -497,34 +497,34 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
497497
498498
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" >}}).
499499
500-
**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.
500+
**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.
501501
502502
{{%/tab%}}
503503
504504
{{%tab name="Amazon Linux 2 LTS"%}}
505505
506-
Using NGINX App Protect WAF with NGINX Controller isn't supported on Amazon Linux 2 LTS.
506+
Using F5 WAF for NGINX with NGINX Controller isn't supported on Amazon Linux 2 LTS.
507507

508508
{{%/tab%}}
509509

510510
{{%tab name="Alpine"%}}
511511

512-
Using NGINX App Protect WAF with NGINX Controller isn't supported on Alpine.
512+
Using F5 WAF for NGINX with NGINX Controller isn't supported on Alpine.
513513
514514
{{%/tab%}}
515515
{{</tabs>}}
516516
517517
<hr>
518518
519-
## Add NGINX App Protect WAF to NGINX Controller
519+
## Add F5 WAF for NGINX to NGINX Controller
520520
521-
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.
521+
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.
522522
523-
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.
523+
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.
524524
525-
## Use NGINX App Protect WAF with NGINX Controller
525+
## Use F5 WAF for NGINX with NGINX Controller
526526
527-
**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.
527+
**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.
528528
529529
Refer to the following NGINX Controller user guides for further information about how to secure your apps and/or APIs with NGINX Controller:
530530

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@ The `reuseport` parameter creates an individual listening socket for each worker
557557

558558
## Extend App Security with Snippets
559559

560-
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" >}}).
560+
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" >}}).
561561

562562
Refer to [Extend App Security with Snippets]({{< ref "extend-app-security-snippets" >}}) for more information and examples.
563563

content/controller/app-delivery/security/concepts/bring-your-own-policy.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Learn how to use your own F5 NGINX App Protect WAF policies with NGINX
2+
description: Learn how to use your own F5 WAF for NGINX policies with NGINX
33
Controller.
44
nd-docs: DOCS-481
55
title: Bring Your Own WAF Policy
@@ -17,35 +17,35 @@ A BYO NGINX App Protect policy lets you maintain consistent Security Policies ac
1717

1818
To export a policy from F5 Advanced WAF or ASM, take the following steps:
1919

20-
1. Convert your F5 XML security policy to an NGINX App Protect WAF declarative JSON policy using the [NGINX App Protect Policy Converter tool](https://docs.nginx.com/nginx-app-protect/configuration/#policy-converter).
20+
1. Convert your F5 XML security policy to an F5 WAF for NGINX declarative JSON policy using the [NGINX App Protect Policy Converter tool](https://docs.nginx.com/nginx-app-protect/configuration/#policy-converter).
2121
{{< call-out "note" >}}We recommend using the Converter tool that corresponds with the most recent NGINX App Protect version.{{< /call-out >}}
2222

2323
2. Use the NGINX App Protect declarative JSON policy as the WAF policy in NGINX Controller for your app component(s).
2424

2525
&nbsp;
2626

27-
With a BYO NGINX App Protect policy, you can also provide customized security by crafting an NGINX App Protect WAF policy that specifies the security controls appropriate for your apps. For more information on how to configure an NGINX App Protect WAF policy, refer to the [NGINX App Protect Configuration Guide](https://docs.nginx.com/nginx-app-protect/configuration/).
27+
With a BYO NGINX App Protect policy, you can also provide customized security by crafting an F5 WAF for NGINX policy that specifies the security controls appropriate for your apps. For more information on how to configure an F5 WAF for NGINX policy, refer to the [NGINX App Protect Configuration Guide](https://docs.nginx.com/nginx-app-protect/configuration/).
2828

2929
## Security Strategy for BYO NGINX App Protect Policy
3030

3131
The BYO NGINX App Protect policy uses the concept of a [Security Strategy]({{< ref "/controller/app-delivery/security/concepts/what-is-waf.md#security-policy-and-security-strategy" >}})
3232

3333
With the BYO NGINX App Protect policy feature, you can specify the exact NGINX App Protect policy for the Security Strategy. Then, the Security Strategy can be shared across -- and referenced by -- multiple app components.
34-
A Security Strategy can be comprised of various app-security-related Security Policies. NGINX Controller includes a custom NGINX App Protect WAF policy, which can be assigned to a Security Strategy.
34+
A Security Strategy can be comprised of various app-security-related Security Policies. NGINX Controller includes a custom F5 WAF for NGINX policy, which can be assigned to a Security Strategy.
3535

36-
You can also add a BYO NGINX App Protect WAF policy in JSON format to NGINX Controller "as-is" for use in a Security Strategy.
36+
You can also add a BYO F5 WAF for NGINX policy in JSON format to NGINX Controller "as-is" for use in a Security Strategy.
3737

3838

39-
An **App Component** contains a reference to a **Security Strategy**, which, in turn, references a Security Policy. This Security Policy contains the **NGINX App Protect WAF policy**.
39+
An **App Component** contains a reference to a **Security Strategy**, which, in turn, references a Security Policy. This Security Policy contains the **F5 WAF for NGINX policy**.
4040

4141
Refer to the topic [Enable WAF for a Component Using Your Own NGINX App Protect Policy]({{< ref "/controller/app-delivery/security/tutorials/add-app-security-with-waf.md#enable-waf-for-a-component-using-your-own-nap-policy-beta" >}}) to get started.
4242

4343
## Limitations
4444

4545
BYO NAP WAF policy currently has the following limitations:
4646

47-
- The size of the BYO NGINX App Protect WAF policy that's referenced by app components may affect application performance.
48-
- References to external files, such as the following, in the NGINX App Protect WAF JSON declarative policy are not supported:
47+
- The size of the BYO F5 WAF for NGINX policy that's referenced by app components may affect application performance.
48+
- References to external files, such as the following, in the F5 WAF for NGINX JSON declarative policy are not supported:
4949
- User Defined Signatures
5050
- Security controls in external references
5151
- Referenced OpenAPI spec files

0 commit comments

Comments
 (0)