You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix NAP WAF v5 example link, minor style issues (#6294)
One of the links in the NGINX App Protect V5 configuration
document is broken. This commit fixes the link, and also
makes some other changes so the document is more
closely in line with contemporary standards.
Copy file name to clipboardExpand all lines: docs/content/installation/integrations/app-protect-waf-v5/configuration.md
+15-18Lines changed: 15 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,15 @@ toc: true
5
5
weight: 200
6
6
---
7
7
8
-
9
8
## Overview
10
9
11
10
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/).
12
11
13
-
{{< note >}} Check out the complete NGINX Ingress Controller with NGINX App Protect WAF example resources on GitHub[for VirtualServer resources](https://github.com/nginxinc/kubernetes-ingress/tree/v{{< nic-version >}}/examples/custom-resources/app-protect-waf-v5). 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 >}}
12
+
{{< note >}} There are complete NGINX Ingress Controller with NGINX App Protect WAF [example resources on GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v{{< nic-version >}}/examples/custom-resources/app-protect-waf-v5).
14
13
14
+
F5 recommends recompiling your NGINX AppProtect WAF Policy Bundles with each release of NGINX Ingress Controller. This ensures Policies remain compatible and are compiled with the latest attack signatures, bot signatures, and Ttreat campaigns.{{< /note >}}
15
15
16
-
## Global Configuration
16
+
## Global configuration
17
17
18
18
NGINX Ingress Controller has global configuration parameters that match those in NGINX App Protect WAF. They are found in the [ConfigMap resource]({{< relref "configuration/global-configuration/configmap-resource.md#modules" >}}): the NGINX App Protect WAF parameters are prefixed with `app-protect*`.
19
19
@@ -22,17 +22,16 @@ NGINX Ingress Controller has global configuration parameters that match those in
22
22
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" >}}).
23
23
24
24
25
-
## NGINX App Protect WAF Bundles {#waf-bundles}
25
+
## NGINX App Protect WAF Bundles
26
26
27
-
You define App Protect WAF bundles for VirtualServer custom resources by creating policy bundles and putting them on a mounted volume accessible from NGINX Ingress Controller.
27
+
App Protect WAF bundles for VirtualServer custom resources are defined by creating policy bundles and putting them on a mounted volume accessible from NGINX Ingress Controller.
28
28
29
29
Before applying a policy, a WAF policy bundle must be created, then copied to a volume mounted to `/etc/app_protect/bundles`.
30
30
31
31
{{< note >}} NGINX Ingress Controller supports `securityLogs` for policy bundles. Log bundles must also be copied to a volume mounted to `/etc/app_protect/bundles`. {{< /note >}}
32
32
33
33
This example shows how a policy is configured by referencing a generated WAF Policy Bundle:
34
34
35
-
36
35
```yaml
37
36
apiVersion: k8s.nginx.org/v1
38
37
kind: Policy
@@ -46,7 +45,6 @@ spec:
46
45
47
46
This example shows the same policy as above but with a log bundle used for security log configuration:
48
47
49
-
50
48
```yaml
51
49
apiVersion: k8s.nginx.org/v1
52
50
kind: Policy
@@ -62,13 +60,13 @@ spec:
62
60
logDest: "syslog:server=syslog-svc.default:514"
63
61
```
64
62
65
-
## Configuration in NGINX Plus Ingress Controller using Virtual Server Resource
63
+
## Configure NGINX Plus Ingress Controller using Virtual Server resources
66
64
67
65
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.
68
66
69
-
{{< note >}} You can find the files for this example on [GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v{{< nic-version >}}/examples/custom-resources/app-protect-waf/app-protect-waf-v5).{{< /note >}}
67
+
{{< note >}} You can find the files for this example on [GitHub](https://github.com/nginxinc/kubernetes-ingress/tree/v{{< nic-version >}}/examples/custom-resources/app-protect-waf-v5).{{< /note >}}
70
68
71
-
## Prerequisites
69
+
### Prerequisites
72
70
73
71
1. Follow the installation [instructions]({{< relref "installation/integrations/app-protect-waf-v5/installation.md" >}}) to deploy NGINX Ingress Controller with NGINX Plus and NGINX App Protect WAF version 5.
74
72
@@ -84,15 +82,15 @@ This example shows how to deploy NGINX Ingress Controller with NGINX Plus and NG
{{< note >}} Configuration settings in the Policy resource enable WAF protection by configuring NGINX App Protect WAF with the log configuration created in the previous step. The policy bundle referenced as `your_policy_bundle_name.tgz` need to be created and placed in the `/etc/app_protect/bundles` volume first.{{</ note >}}
@@ -113,8 +111,7 @@ Create and deploy the WAF policy.
113
111
```
114
112
115
113
116
-
### Step 4 - Configure Load Balancing
117
-
114
+
### Configure load balancing
118
115
119
116
{{< note >}} VirtualServer references the `waf-policy` created in Step 3.{{</ note >}}
120
117
@@ -125,9 +122,9 @@ Create and deploy the WAF policy.
125
122
```
126
123
127
124
128
-
### Step 5 - Test the Application
125
+
### Test the application
129
126
130
-
To access the application, curl the coffee and the tea services. We'll use the `--resolve` option to set the Host header of a request with `webapp.example.com`
127
+
To access the application, curl the coffee and the tea services. Use the `--resolve` option to set the Host header of a request with `webapp.example.com`
131
128
132
129
1. Send a request to the application:
133
130
@@ -156,7 +153,7 @@ To access the application, curl the coffee and the tea services. We'll use the `
The GitHub repository has a full [VirtualServer example](https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v{{< nic-version >}}/examples/custom-resources/app-protect-waf-v5/webapp.yaml).
0 commit comments