Skip to content

WAF v5 docs update #5719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 87 commits into from
Jun 25, 2024
Merged
Changes from 1 commit
Commits
Show all changes
87 commits
Select commit Hold shift + click to select a range
fecb959
WIP - WAFv5 docs
jjngx Jun 10, 2024
1b1f293
Update make targets
jjngx Jun 10, 2024
44393ac
Update troubleshooting doc, re-ordering pages
jjngx Jun 10, 2024
1249c75
Bump redhat/ubi8 from `2a5d234` to `143123d` in /build (#5715)
dependabot[bot] Jun 10, 2024
cde8d24
[pre-commit.ci] pre-commit autoupdate (#5724)
pre-commit-ci[bot] Jun 11, 2024
6b98b56
Bump docker/build-push-action from 5.3.0 to 5.4.0 in the actions grou…
dependabot[bot] Jun 11, 2024
678e85e
Docs - pulling NIC WAF images
jjngx Jun 11, 2024
26052a1
Docs - pulling NIC WAF images
jjngx Jun 11, 2024
36012e0
Building NIC - make targets
jjngx Jun 11, 2024
dd7df3a
Update installation doc
jjngx Jun 11, 2024
ceaf8f4
Update installation docs for WAF v5
jjngx Jun 11, 2024
deed446
Fix merge conflict
jjngx Jun 12, 2024
0b794a6
Remove ref to json policies from WAFv5 doc, update waf docker image tags
jjngx Jun 12, 2024
74127b9
Merge branch 'main' into docs/waf5
jjngx Jun 13, 2024
f191e5f
Merge branch 'main' into docs/waf5
jjngx Jun 13, 2024
100c38b
Merge branch 'main' into docs/waf5
jjngx Jun 14, 2024
f95acbd
Merge branch 'main' into docs/waf5
jjngx Jun 14, 2024
3312260
Merge branch 'main' into docs/waf5
jjngx Jun 17, 2024
9dc5a70
Fix hugo build
jjngx Jun 17, 2024
9ae8176
Merge branch 'main' into docs/waf5
jjngx Jun 17, 2024
d6acfbc
Merge branch 'main' into docs/waf5
jjngx Jun 17, 2024
0de914b
Merge branch 'main' into docs/waf5
shaun-nx Jun 18, 2024
8aabfc6
Add waf5 bundle example
jjngx Jun 18, 2024
ae88c06
Merge branch 'main' into docs/waf5
jjngx Jun 18, 2024
ca2ba78
Merge branch 'main' into docs/waf5
shaun-nx Jun 19, 2024
3ff5e9b
Merge branch 'main' into docs/waf5
shaun-nx Jun 19, 2024
130bb8b
Remove examples
shaun-nx Jun 19, 2024
3460ce7
Merge branch 'main' into docs/waf5
shaun-nx Jun 19, 2024
70fcfd9
Update waf v5 configuration guide
shaun-nx Jun 19, 2024
48a34ac
Merge branch 'main' into docs/waf5
shaun-nx Jun 19, 2024
56e06b7
Update docs/content/installation/integrations/app-protect-waf-v5/conf…
jjngx Jun 19, 2024
d33274f
Update docs/content/installation/integrations/app-protect-waf-v5/conf…
jjngx Jun 19, 2024
4c66949
Update docs/content/installation/integrations/app-protect-waf-v5/inst…
jjngx Jun 19, 2024
8682239
Update docs/content/installation/integrations/app-protect-waf-v5/_ind…
jjngx Jun 19, 2024
33b1cca
Merge branch 'main' into docs/waf5
jjngx Jun 19, 2024
d60b72c
Fix a link
jjngx Jun 19, 2024
31aa89d
Fix rendering issue
jjngx Jun 19, 2024
f5fa9e7
Remove ref to WAF from WAFv5 section
jjngx Jun 19, 2024
5b072b7
Merge branch 'main' into docs/waf5
ADubhlaoich Jun 19, 2024
331888c
Merge branch 'main' into docs/waf5
ADubhlaoich Jun 20, 2024
0d8facb
Merge branch 'main' into docs/waf5
ADubhlaoich Jun 20, 2024
7124f5a
Remove references to WAF from WAF v5 docs
jjngx Jun 20, 2024
7a53380
Merge branch 'main' into docs/waf5
oseoin Jun 20, 2024
c659899
Merge branch 'main' into docs/waf5
jjngx Jun 21, 2024
da351e8
Update config steps for policy bundle
jjngx Jun 21, 2024
5db5f53
Update docs/content/installation/integrations/app-protect-waf-v5/conf…
jjngx Jun 21, 2024
f0b73cb
Update docs/content/installation/integrations/app-protect-waf-v5/conf…
jjngx Jun 21, 2024
9741530
Update docs/content/installation/integrations/app-protect-waf-v5/inst…
jjngx Jun 21, 2024
c8b276a
Use hugo native syntax for notes
jjngx Jun 21, 2024
3f7b2ce
Don't use explicit anchors
jjngx Jun 21, 2024
5a7d560
Update notes
jjngx Jun 21, 2024
683cb03
Add helm install and configuration stage for waf v5
shaun-nx Jun 21, 2024
bab716b
Update helm deployment example
shaun-nx Jun 21, 2024
3e5c90c
Merge branch 'main' into docs/waf5
shaun-nx Jun 21, 2024
9f1ed0b
Corret typo and add note regarding default volunes with emptyDir
shaun-nx Jun 21, 2024
17d6dd6
Merge branch 'main' into docs/waf5
shaun-nx Jun 21, 2024
9c1858b
Correct typo
shaun-nx Jun 24, 2024
76fcc90
Merge branch 'main' into docs/waf5
shaun-nx Jun 24, 2024
119a45f
Merge branch 'main' into docs/waf5
shaun-nx Jun 24, 2024
1c46455
Merge branch 'main' into docs/waf5
shaun-nx Jun 24, 2024
499c38a
Merge branch 'main' into docs/waf5
shaun-nx Jun 24, 2024
6cefd48
Merge branch 'main' into docs/waf5
shaun-nx Jun 24, 2024
d73c743
Move the RBAC section into the Install With Manifests section + remov…
shaun-nx Jun 24, 2024
0b3a82a
Merge branch 'main' into docs/waf5
shaun-nx Jun 24, 2024
f9ebec1
Merge branch 'main' into docs/waf5
ADubhlaoich Jun 24, 2024
ca3bd9f
Update docs/content/installation/integrations/app-protect-waf-v5/conf…
shaun-nx Jun 24, 2024
618ef32
Update docs/content/installation/integrations/app-protect-waf-v5/conf…
shaun-nx Jun 24, 2024
b838e21
Update docs/content/installation/integrations/app-protect-waf-v5/conf…
shaun-nx Jun 24, 2024
0e2032f
Update docs/content/installation/integrations/app-protect-waf-v5/conf…
shaun-nx Jun 24, 2024
6932cc2
Update docs/content/installation/integrations/app-protect-waf-v5/conf…
shaun-nx Jun 24, 2024
d076fd6
Update docs/content/installation/integrations/app-protect-waf-v5/conf…
shaun-nx Jun 24, 2024
b0579dc
Update docs/content/installation/integrations/app-protect-waf-v5/trou…
shaun-nx Jun 24, 2024
5443259
Update docs/content/installation/integrations/app-protect-waf-v5/trou…
shaun-nx Jun 24, 2024
a6bec22
Update docs/content/installation/integrations/app-protect-waf-v5/trou…
shaun-nx Jun 24, 2024
560e77c
Update docs/content/installation/integrations/app-protect-waf-v5/trou…
shaun-nx Jun 24, 2024
30405ba
Update docs/content/installation/integrations/app-protect-waf-v5/trou…
shaun-nx Jun 24, 2024
bde1152
Update docs/content/installation/integrations/app-protect-waf-v5/trou…
shaun-nx Jun 24, 2024
2a874be
Update docs/content/installation/integrations/app-protect-waf-v5/trou…
shaun-nx Jun 24, 2024
1ffaf2b
Update docs/content/installation/integrations/app-protect-waf-v5/trou…
shaun-nx Jun 24, 2024
13902f7
Merge branch 'main' into docs/waf5
shaun-nx Jun 24, 2024
43bb219
Remove troubleshooting guide
shaun-nx Jun 24, 2024
40f4412
Undo changes in Dockerfile
jjngx Jun 25, 2024
9b0ca60
Merge branch 'main' into docs/waf5
vepatel Jun 25, 2024
f8d0640
Newline in dockerfile
shaun-nx Jun 25, 2024
355ea01
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 25, 2024
1577611
Update NIC version
jjngx Jun 25, 2024
31dce9c
Re-add troubleshooting guide for v4
shaun-nx Jun 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Use hugo native syntax for notes
  • Loading branch information
jjngx committed Jun 21, 2024
commit c8b276ac6fba5cb2039cf15f65ccf54ad5295373
Original file line number Diff line number Diff line change
Expand Up @@ -107,27 +107,31 @@ Create the syslog service and pod for the NGINX App Protect WAF security logs:

### Step 3 - Deploy the WAF Policy

Create and deploy the WAF policy

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

Create and deploy the WAF policy.

```shell
kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.6.0/examples/custom-resources/app-protect-waf-v5/waf.yaml
```

Note: the NGINX App Protect WAF configuration settings in the Policy resource. They 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 volume `/etc/app_protect/bundles` first.


### Step 4 - Configure Load Balancing


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

1. Create the VirtualServer Resource:

```shell
kubectl apply -f https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.6.0/examples/custom-resources/app-protect-waf-v5/virtual-server.yaml
```

Note that the VirtualServer references the policy waf-policy bundle created in Step 3.

### Step 5 - Test the Application

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

1. Send a request to the application:

Expand Down