Skip to content

Commit c7a33c3

Browse files
nginx-botnginx-bot
authored
[cherry-pick] Update NAP documentation for 4.1 release (#7615)
1 parent 4bd97d6 commit c7a33c3

File tree

6 files changed

+45
-43
lines changed

6 files changed

+45
-43
lines changed

‎site/content/includes/compatibility-tables/nic-nap.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
The following table shows compatibility between NGINX Ingress Controller (NIC) and NGINX App Protect WAF (NAP-WAF) versions:
2+
3+
{{< bootstrap-table "table table-striped table-responsive" >}}
4+
| NIC Version | NAP-WAF Version | Config Manager | Enforcer |
5+
| ------------------- | --------------- | -------------- | -------- |
6+
| {{< nic-version >}} | 34+5.332 | 5.6.0 | 5.6.0 |
7+
| 4.0.1 | 33+5.264 | 5.5.0 | 5.5.0 |
8+
| 3.7.2 | 32+5.1 | 5.3.0 | 5.3.0 |
9+
| 3.6.2 | 32+5.48 | 5.2.0 | 5.2.0 |
10+
{{% /bootstrap-table %}}

‎site/content/installation/integrations/app-protect-waf-v5/configuration.md‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
docs: DOCS-000
3-
title: Configuration
4-
toc: true
2+
title: Configure NGINX App Protect with NGINX Ingress Controller
53
weight: 200
4+
toc: true
5+
type: how-to
6+
product: NIC
7+
docs: DOCS-000
68
---
79

810
## Overview
911

1012
This document explains how to use F5 NGINX Ingress Controller to configure [NGINX App Protect WAF v5](https://docs.nginx.com/nginx-app-protect-waf/v5/).
1113

12-
{{< note >}} There are complete NGINX Ingress Controller with NGINX App Protect WAF [example resources on GitHub](https://github.com/nginx/kubernetes-ingress/tree/v{{< nic-version >}}/examples/custom-resources/app-protect-waf-v5).
13-
14-
F5 recommends compiling/recompiling your NGINX AppProtect WAF Policy Bundles using the [NGINX App Protect Compiler](https://docs.nginx.com/nginx-app-protect-waf/v5/admin-guide/compiler/) with each release of NGINX Ingress Controller. This ensures Policies remain compatible and are compiled with the latest attack signatures, bot signatures, and Threat campaigns.{{< /note >}}
14+
{{< note >}} There are complete NGINX Ingress Controller with NGINX App Protect WAF [example resources on GitHub](https://github.com/nginx/kubernetes-ingress/tree/v{{< nic-version >}}/examples/custom-resources/app-protect-waf-v5). {{< /note >}}
1515

1616
## Global configuration
1717

@@ -21,6 +21,7 @@ NGINX Ingress Controller has global configuration parameters that match those in
2121

2222
NGINX App Protect WAF v5 can be enabled and configured for custom resources only(VirtualServer, VirtualServerRoute). You need to create a Policy Custom Resource referencing a policy bundle, then add it to the VirtualServer/VirtualServerRoute definition. Additional detail can be found in the [Policy Resource documentation]({{< relref "configuration/policy-resource.md#waf" >}}).
2323

24+
---
2425

2526
## NGINX App Protect WAF Bundles
2627

@@ -60,6 +61,8 @@ spec:
6061
logDest: "syslog:server=syslog-svc.default:514"
6162
```
6263
64+
---
65+
6366
## Configure NGINX Plus Ingress Controller using Virtual Server resources
6467
6568
This example shows how to deploy NGINX Ingress Controller with NGINX Plus and NGINX App Protect WAF v5, deploy a simple web application, and then configure load balancing and WAF protection for that application using the VirtualServer resource.

‎site/content/installation/integrations/app-protect-waf-v5/installation.md‎

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
---
2-
docs: DOCS-000
3-
doctypes:
4-
- ''
5-
title: Build NGINX Ingress Controller with NGINX App Protect WAF v5
6-
toc: true
2+
title: Build NGINX Ingress Controller with NGINX App Protect WAF
73
weight: 100
4+
toc: true
5+
type: how-to
6+
product: NIC
7+
docs: DOCS-000
88
---
99

10-
This document explains how to build a F5 NGINX Ingress Controller image with F5 NGINX App Protect WAF v5 from source code.
10+
This document explains how to build a F5 NGINX Ingress Controller image with NGINX App Protect WAF v5 from source code.
1111

1212
{{<call-out "tip" "Pre-built image alternatives" >}} If you'd rather not build your own NGINX Ingress Controller image, see the [pre-built image options](#pre-built-images) at the end of this guide.{{</call-out>}}
1313

14-
## Before you start
14+
## Before you begin
1515

1616
- To use NGINX App Protect WAF with NGINX Ingress Controller, you must have NGINX Plus.
1717

18+
{{< include "/compatibility-tables/nic-nap.md" >}}
19+
20+
---
21+
1822
## Prepare the environment
1923

2024
Get your system ready for building and pushing the NGINX Ingress Controller image with NGINX App Protect WAF v5.
@@ -499,18 +503,3 @@ If you prefer not to build your own NGINX Ingress Controller image, you can use
499503
500504
- Download the image using your NGINX Ingress Controller subscription certificate and key. View the [Get NGINX Ingress Controller from the F5 Registry]({{< relref "installation/nic-images/get-registry-image.md" >}}) topic.
501505
- The [Get the NGINX Ingress Controller image with JWT]({{< relref "installation/nic-images/get-image-using-jwt.md" >}}) topic describes how to use your subscription JWT token to get the image.
502-
503-
---
504-
505-
## [NGINX App Protect WAF v5 version](https://docs.nginx.com/nginx-app-protect-waf/v5/releases/)
506-
507-
{{< bootstrap-table "table table-bordered table-striped table-responsive" >}}
508-
| NIC Version | App Protect WAFv5 Version | Config Manager | Enforcer |
509-
| --- | --- | --- | --- |
510-
| {{< nic-version >}} | 33_5.342 | 5.6.0 | 5.6.0 |
511-
| 4.0.1 | 33_5.264 | 5.5.0 | 5.5.0 |
512-
| 3.7.2 | 32_5.144 | 5.3.0 | 5.3.0 |
513-
| 3.6.2 | 32_5.48 | 5.2.0 | 5.2.0 |
514-
{{% /bootstrap-table %}}
515-
516-
{{< note >}} F5 recommends to re-compile your NGINX AppProtect WAF Policy Bundles with each release of NGINX Ingress Controller. This will ensure your Policies remain compatible and are compiled with the latest Attack Signatures, Bot Signatures, and Threat Campaigns.{{< /note >}}

‎site/content/installation/integrations/app-protect-waf/troubleshoot-app-protect-waf.md‎ renamed to ‎site/content/installation/integrations/app-protect-waf-v5/troubleshoot-app-protect-waf.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
docs: DOCS-0000
3-
doctypes:
4-
- ''
52
title: Troubleshoot NGINX App Protect WAF
3+
weight: 400
64
toc: true
7-
weight: 300
5+
type: how-to
6+
product: NIC
7+
docs: DOCS-000
88
---
99

1010
This document describes how to troubleshoot problems when using NGINX Ingress Controller and the NGINX App Protect WAF module version 5.
1111

1212
For general troubleshooting of NGINX Ingress Controller, check the general [troubleshooting]({{< relref "troubleshooting/troubleshoot-common" >}}) documentation.
1313

14-
{{< see-also >}} You can find more troubleshooting tips in the NGINX App Protect WAF [troubleshooting guide](/nginx-app-protect/v5/troubleshooting/) {{< /see-also >}}.
14+
{{< see-also >}} You can find more troubleshooting tips in the NGINX App Protect WAF [troubleshooting guide](https://docs.nginx.com/nginx-app-protect-waf/v5/troubleshooting-guide/troubleshooting/) {{< /see-also >}}.
1515

1616
## Potential problems
1717

‎site/content/installation/integrations/app-protect-waf/configuration.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
docs: DOCS-578
3-
doctypes:
4-
- ''
5-
title: Configuration
6-
toc: true
2+
title: Configure NGINX App Protect with NGINX Ingress Controller
73
weight: 200
4+
toc: true
5+
type: how-to
6+
product: NIC
7+
docs: DOCS-578
88
---
99

1010
This document explains how to use F5 NGINX Ingress Controller to configure NGINX App Protect WAF.
@@ -158,7 +158,7 @@ You can define NGINX App Protect WAF [User-Defined Signatures](/nginx-app-protec
158158

159159
The field `revisionDatetime` is not currently supported.
160160

161-
`APUserSig` resources increase the reload time of NGINX Plus compared with `APPolicy` and `APLogConf` resources. Read [NGINX fails to start or reload]({{< relref "installation/integrations/app-protect-waf/troubleshoot-app-protect-waf.md#nginx-fails-to-start-or-reload" >}}) for more information.
161+
`APUserSig` resources increase the reload time of NGINX Plus compared with `APPolicy` and `APLogConf` resources. Read [NGINX fails to start or reload]({{< relref "installation/integrations/app-protect-waf-v5/troubleshoot-app-protect-waf.md#nginx-fails-to-start-or-reload" >}}) for more information.
162162

163163
{{< /note >}}
164164

‎site/content/installation/integrations/app-protect-waf/installation.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
docs: DOCS-579
3-
doctypes:
4-
- ''
52
title: Build NGINX Ingress Controller with NGINX App Protect WAF
6-
toc: true
73
weight: 100
4+
toc: true
5+
type: how-to
6+
product: NIC
7+
docs: DOCS-579
88
---
99

1010
This document explains how to build a F5 NGINX Ingress Controller image with F5 NGINX App Protect WAF from source code.

0 commit comments

Comments
 (0)