Skip to content

Commit ccd88fd

Browse files
authored
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.
1 parent e2342a3 commit ccd88fd

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

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

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ toc: true
55
weight: 200
66
---
77

8-
98
## Overview
109

1110
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/).
1211

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).
1413

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 >}}
1515

16-
## Global Configuration
16+
## Global configuration
1717

1818
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*`.
1919

@@ -22,17 +22,16 @@ NGINX Ingress Controller has global configuration parameters that match those in
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

2424

25-
## NGINX App Protect WAF Bundles {#waf-bundles}
25+
## NGINX App Protect WAF Bundles
2626

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.
2828

2929
Before applying a policy, a WAF policy bundle must be created, then copied to a volume mounted to `/etc/app_protect/bundles`.
3030

3131
{{< 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 >}}
3232

3333
This example shows how a policy is configured by referencing a generated WAF Policy Bundle:
3434

35-
3635
```yaml
3736
apiVersion: k8s.nginx.org/v1
3837
kind: Policy
@@ -46,7 +45,6 @@ spec:
4645
4746
This example shows the same policy as above but with a log bundle used for security log configuration:
4847
49-
5048
```yaml
5149
apiVersion: k8s.nginx.org/v1
5250
kind: Policy
@@ -62,13 +60,13 @@ spec:
6260
logDest: "syslog:server=syslog-svc.default:514"
6361
```
6462
65-
## Configuration in NGINX Plus Ingress Controller using Virtual Server Resource
63+
## Configure NGINX Plus Ingress Controller using Virtual Server resources
6664
6765
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.
6866
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 >}}
7068
71-
## Prerequisites
69+
### Prerequisites
7270
7371
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.
7472
@@ -84,15 +82,15 @@ This example shows how to deploy NGINX Ingress Controller with NGINX Plus and NG
8482
IC_HTTP_PORT=<port number>
8583
```
8684

87-
### Step 1. Deploy a Web Application
85+
### Deploy a web application
8886

8987
Create the application deployment and service:
9088

9189
```shell
9290
kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v{{< nic-version >}}/examples/custom-resources/app-protect-waf-v5/webapp.yaml
9391
```
9492

95-
### Step 2. Create the Syslog Service
93+
### Create the Syslog service
9694

9795
Create the syslog service and pod for the NGINX App Protect WAF security logs:
9896

@@ -101,7 +99,7 @@ Create the syslog service and pod for the NGINX App Protect WAF security logs:
10199
kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v{{< nic-version >}}/examples/custom-resources/app-protect-waf-v5/syslog.yaml
102100
```
103101

104-
### Step 3 - Deploy the WAF Policy
102+
### Deploy the WAF Policy
105103

106104

107105
{{< 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.
113111
```
114112

115113

116-
### Step 4 - Configure Load Balancing
117-
114+
### Configure load balancing
118115

119116
{{< note >}} VirtualServer references the `waf-policy` created in Step 3.{{</ note >}}
120117

@@ -125,9 +122,9 @@ Create and deploy the WAF policy.
125122
```
126123

127124

128-
### Step 5 - Test the Application
125+
### Test the application
129126

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`
131128

132129
1. Send a request to the application:
133130

@@ -156,7 +153,7 @@ To access the application, curl the coffee and the tea services. We'll use the `
156153
kubectl exec -it <SYSLOG_POD> -- cat /var/log/messages
157154
```
158155

159-
### Example VirtualServer configuration
156+
## Example VirtualServer configuration
160157

161158
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).
162159

0 commit comments

Comments
 (0)