Skip to content

Commit de9ea58

Browse files
authored
feat: Add core limitations and missing Docker configuration (#1356)
This commit updates the Markdown linting configuration files, and adds an explanation of the linting available in the repository to the process documentation. The linter itself has been used on multiple files also affected in this commit. There are a handful of peripheral changes made in the PR: - Adding the latest catalogue tags to the Hugo archetype metadata - Fixing a broken link for NGINX Amplify - Fixing duplicate tabs caused by includes (Closes #1343) - Adding reload instructions to NGINX configuration (Closes #1346) - Configuration updates for the repository's automatic labeller Additionally, a small heading naming issue was fixed in the changelog, as well as a formatting style based on our Markdown linting rules.
1 parent aa73bb0 commit de9ea58

File tree

5 files changed

+103
-29
lines changed

5 files changed

+103
-29
lines changed

.github/labeler.yml

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ product/amplify:
2323
- changed-files:
2424
- any-glob-to-any-file: 'content/amplify/**'
2525

26+
product/dos:
27+
- changed-files:
28+
- any-glob-to-any-file:
29+
- 'content/nap-dos/**'
30+
- 'content/includes/nap-dos/**'
31+
2632
product/controller:
2733
- changed-files:
2834
- any-glob-to-any-file:
@@ -37,18 +43,6 @@ product/modsec-waf:
3743
- changed-files:
3844
- any-glob-to-any-file: 'content/modsec-waf/**'
3945

40-
product/nap-dos:
41-
- changed-files:
42-
- any-glob-to-any-file:
43-
- 'content/nap-dos/**'
44-
- 'content/includes/nap-dos/**'
45-
46-
product/nap-waf:
47-
- changed-files:
48-
- any-glob-to-any-file:
49-
- 'content/nap-waf/**'
50-
- 'content/includes/nap-waf/**'
51-
5246
product/ngf:
5347
- changed-files:
5448
- any-glob-to-any-file:
@@ -97,12 +91,19 @@ product/unit:
9791
- 'content/unit/**'
9892
- 'content/includes/unit/**'
9993

94+
product/waf:
95+
- changed-files:
96+
- any-glob-to-any-file:
97+
- 'content/waf/**'
98+
- 'content/includes/waf/**'
99+
100100
# Other labels
101101

102102
process documentation:
103103
- changed-files:
104104
- any-glob-to-any-file:
105105
- 'templates/**'
106+
- 'documentation/**'
106107
- '*.md'
107108
- 'LICENSE'
108109

@@ -122,6 +123,8 @@ tooling:
122123
- '*.sh'
123124
- '*.js'
124125
- 'Makefile'
125-
- '.vale.ini'
126-
- '.gitignore'
127126
- '.gitattributes'
127+
- '.gitignore'
128+
- '.gitlint'
129+
- '.markdownlint.yaml'
130+
- '.vale.ini'

content/waf/changelog/2024.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ For the current year, view [the top-level changelog]({{< ref "/waf/changelog/">}
1717

1818
## F5 WAF for NGINX 5.4 / 4.12
1919

20-
_November 19th, 2024_
20+
Released _November 19th, 2024_.
2121

2222
### New features
2323

@@ -76,7 +76,7 @@ sudo service nginx restart
7676

7777
## F5 WAF for NGINX 5.3 / 4.11
7878

79-
_September 25, 2024_
79+
Released _September 25, 2024_.
8080

8181
### New features
8282

@@ -116,7 +116,7 @@ _September 25, 2024_
116116

117117
## F5 WAF for NGINX 5.2 / 4.10
118118

119-
_May 29, 2024_
119+
Released _May 29, 2024_.
120120

121121
### New features
122122

@@ -149,7 +149,7 @@ _May 29, 2024_
149149

150150
## F5 WAF for NGINX 5.1 / 4.9
151151

152-
_April 18, 2024_
152+
Released _April 18, 2024_.
153153

154154
### New features
155155

@@ -188,7 +188,7 @@ _April 18, 2024_
188188

189189
## F5 WAF for NGINX 5.0 / 4.8.1
190190

191-
_March 19, 2024_
191+
Released _March 19, 2024_.
192192

193193
### New features
194194

@@ -199,7 +199,7 @@ _March 19, 2024_
199199

200200
{{< table >}}
201201

202-
| Distribution name | NGINX Open Source (5.1) | NGINX Plus (5.1) | NGINX Plus (4.8.1) |
202+
| Distribution name | NGINX Open Source (5.0) | NGINX Plus (5.0) | NGINX Plus (4.8.1) |
203203
| ------------------------ | ----------------------------------------------------------------- | -------------------------------------------------------------- |----------------------------------------------------|
204204
| Alpine 3.17 | _app-protect-module-oss-1.25.4+4.815.0-r1.apk_ | _app-protect-module-plus-31+4.815.0-r1.apk_ | _app-protect-31.4.815.0-r1.apk_ |
205205
| Amazon Linux 2023 | _app-protect-module-oss-1.25.4+4.815.0-1.amzn2023.ngx.x86_64.rpm_ | _app-protect-module-plus-31+4.815.0-1.amzn2023.ngx.x86_64.rpm_ | _app-protect-31+4.815.0-1.amzn2023.ngx.x86_64.rpm_ |

content/waf/changelog/_index.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ For older releases, check the changelogs for previous years: [2024]({{< ref "/wa
1919

2020
## F5 WAF for NGINX 5.9
2121

22-
_September 29th, 2025_
22+
Released _September 29th, 2025_.
2323

2424
### New features
2525

@@ -32,6 +32,21 @@ _September 29th, 2025_
3232
- Package and container artifacts now share the same version numbers
3333
- Upgrade processes remain the same as earlier releases
3434
- No breaking changes
35+
36+
{{< call-out "important" >}}
37+
38+
"_V4_" is now represented in the following pages or sections:
39+
40+
- [Virtual machine or bare metal]({{< ref "/waf/install/virtual-environment.md">}})
41+
- Docker [Hybrid]({{< ref "/waf/install/docker.md#hybrid-configuration" >}}) and [Single container]({{< ref "/waf/install/docker.md#single-container-configuration" >}}) configuration
42+
43+
"_V5_" is now represented in the following pages or sections:
44+
45+
- [Kubernetes]({{< ref "/waf/install/kubernetes.md">}})
46+
- Docker [Multi-container]({{< ref "/waf/install/docker.md#multi-container-configuration" >}}) configuration
47+
48+
{{< /call-out >}}
49+
3550
- Restructured documentation
3651
- Product name change
3752
- Version alignment
@@ -58,7 +73,7 @@ _September 29th, 2025_
5873

5974
## NGINX App Protect WAF 5.8 / 4.16
6075

61-
_August 13th, 2025_
76+
Released _August 13th, 2025_.
6277

6378
### New features
6479

@@ -84,7 +99,7 @@ _August 13th, 2025_
8499

85100
## NGINX App Protect WAF 5.7 / 4.15
86101

87-
_June 24th, 2025_
102+
Released _June 24th, 2025_.
88103

89104
### New features
90105

@@ -124,10 +139,9 @@ _June 24th, 2025_
124139

125140
{{< /table >}}
126141

127-
128142
## NGINX App Protect WAF 5.6 / 4.14
129143

130-
_April 1st, 2025_
144+
Released _April 1st, 2025_.
131145

132146
### New features
133147

@@ -167,7 +181,7 @@ _April 1st, 2025_
167181

168182
## NGINX App Protect WAF 5.5 / 4.13
169183

170-
_January 30th, 2025_
184+
Released _January 30th, 2025_.
171185

172186
### New features
173187

content/waf/fundamentals/technical-specifications.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ nd-product: NAP-WAF
1414

1515
This page outlines the technical specifications for F5 WAF for NGINX, which includes the minimum requirements and supported platforms.
1616

17+
## Resource limitations
18+
19+
- F5 WAF for NGINX supports a **maximum** of **127** CPU cores.
20+
1721
## Supported deployment environments
1822

1923
You can deploy F5 WAF for NGINX in the following environments:
@@ -54,9 +58,8 @@ The F5 WAF for NGINX package has the following dependencies:
5458
| app-protect-threat-campaigns | The F5 WAF for NGINX threat campaigns update package |
5559
| nginx-plus-module-appprotect | NGINX Plus dynamic module for F5 WAF for NGINX |
5660

57-
5861
1. _Optional dependencies_
59-
2. _This module needs to be installed separately, and includes a client for downloading and updating the feature's database_
62+
1. _This module needs to be installed separately, and includes a client for downloading and updating the feature's database_
6063

6164
## Supported security policy features
6265

content/waf/install/docker.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,61 @@ Once you have updated your configuration files, you can reload NGINX to apply th
445445

446446
#### Create and run a Docker Compose file
447447

448-
{{< include "waf/install-services-compose.md" >}}
448+
Create a _docker-compose.yml_ file with the following contents in your host environment, replacing image tags as appropriate:
449+
450+
```yaml
451+
services:
452+
nginx:
453+
container_name: nginx
454+
image: nginx-app-protect-5
455+
volumes:
456+
- app_protect_bd_config:/opt/app_protect/bd_config
457+
- app_protect_config:/opt/app_protect/config
458+
- app_protect_etc_config:/etc/app_protect/conf
459+
- /conf/nginx.conf:/etc/nginx/nginx.conf
460+
- /conf/default.conf:/etc/nginx/conf.d/default.conf
461+
- ./license.jwt:/etc/nginx/license.jwt # Only necessary when using NGINX Plus
462+
networks:
463+
- waf_network
464+
ports:
465+
- "80:80"
466+
467+
waf-enforcer:
468+
container_name: waf-enforcer
469+
image: waf-enforcer:5.2.0
470+
environment:
471+
- ENFORCER_PORT=50000
472+
ports:
473+
- "50000:50000"
474+
volumes:
475+
- /opt/app_protect/bd_config:/opt/app_protect/bd_config
476+
networks:
477+
- waf_network
478+
restart: always
479+
480+
waf-config-mgr:
481+
container_name: waf-config-mgr
482+
image: waf-config-mgr:5.2.0
483+
volumes:
484+
- /opt/app_protect/bd_config:/opt/app_protect/bd_config
485+
- /opt/app_protect/config:/opt/app_protect/config
486+
- /etc/app_protect/conf:/etc/app_protect/conf
487+
restart: always
488+
network_mode: none
489+
depends_on:
490+
waf-enforcer:
491+
condition: service_started
492+
493+
networks:
494+
waf_network:
495+
driver: bridge
496+
```
497+
498+
To start the F5 WAF for NGINX services, use `docker compose up` in the same folder as the _docker-compose.yml_ file:
499+
500+
```shell
501+
sudo docker compose up -d
502+
```
449503

450504
You can now review the operational status of F5 WAF for NGINX using the [Post-installation checks]({{< ref "/waf/install/docker.md#post-installation-checks" >}}).
451505

0 commit comments

Comments
 (0)