Skip to content

Commit 02b0041

Browse files
balakoteswarJTorreGADubhlaoich
authored
docs: update the NAP and NIM versions for new NIM NAP compiler (#767)
* docs: update the NAP and NIM versions for new NIM NAP compiler * fix: Update content/includes/nim/tech-specs/security-data-plane-dependencies.md Co-authored-by: Jon Torre <[email protected]> * fix: Update content/includes/nim/tech-specs/security-management-plane-dependencies.md Co-authored-by: Jon Torre <[email protected]> --------- Co-authored-by: Jon Torre <[email protected]> Co-authored-by: Alan Dooley <[email protected]>
1 parent f28a736 commit 02b0041

File tree

4 files changed

+24
-15
lines changed

4 files changed

+24
-15
lines changed

‎content/includes/nim/tech-specs/nim-app-protect-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ NGINX Instance Manager supports the following versions of [NGINX App Protect WAF
88

99
| NGINX Instance Manager | NGINX App Protect WAF |
1010
|------------------------|------------------------------------|
11-
| 2.17.0–2.19.2 | Release 4.8.0–4.14.0, 5.1.0–5.6.0 |
11+
| 2.17.0–2.20.0 | Release 4.8.0–4.15.0, 5.1.0–5.7.0 |
1212
| 2.15.1–2.16.0 | Release 4.8.0–4.10.0 |
1313
| 2.14.1–2.15.0 | Release 4.4.0–4.7.0 |
1414
| 2.13.0–2.14.0 | Release 4.3.0–4.5.0 |

‎content/includes/nim/tech-specs/security-data-plane-dependencies.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
The Security Monitoring module requires the following versions of [NGINX App Protect WAF](https://docs.nginx.com/nginx-app-protect/) and [NGINX Plus](https://www.f5.com/products/nginx/nginx-plus) for the **data plane**:
22

3+
{{< note >}}
4+
In NGINX Instance Manager 2.18.0 and under, the Security Monitoring module was a separate package that was installed manually.
5+
From NGINX Instance Manager 2.19.0 onward, Security Monitoring is part of the NGINX Instance Manager feature-set and is packaged by default; no manual installation or upgrade is needed.
6+
{{< /note >}}
7+
38
{{<bootstrap-table "table table-striped table-bordered">}}
49

510
| Security Monitoring | NGINX App Protect WAF |

‎content/includes/nim/tech-specs/security-management-plane-dependencies.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
The Security Monitoring module requires the following versions of NGINX Instance Manager to be installed on the **management plane**.
22

3-
{{< note >}}The Security Monitoring module doesn’t automatically install or upgrade NGINX Instance Manager. You’ll need to manually install or upgrade NGINX Instance Manager to a supported version.
3+
{{< note >}}
4+
In NGINX Instance Manager 2.18.0 and under, the Security Monitoring module was a separate package that was installed manually.
5+
From NGINX Instance Manager 2.19.0 onward, Security Monitoring is part of the NGINX Instance Manager feature-set and is packaged by default; no manual installation or upgrade is needed.
46
{{< /note >}}
57

68
{{<bootstrap-table "table table-striped table-bordered">}}

‎content/nim/nginx-app-protect/setup-waf-config-management.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,14 @@ The table below shows which WAF compiler version to use for each version of NGIN
5555

5656
| NGINX App Protect WAF version | WAF compiler version |
5757
|-------------------------------|----------------------------|
58+
| 5.7.0 | nms-nap-compiler-v5.442.0 |
5859
| 5.6.0 | nms-nap-compiler-v5.342.0 |
5960
| 5.5.0 | nms-nap-compiler-v5.264.0 |
6061
| 5.4.0 | nms-nap-compiler-v5.210.0 |
6162
| 5.3.0 | nms-nap-compiler-v5.144.0 |
6263
| 5.2.0 | nms-nap-compiler-v5.48.0 |
6364
| 5.1.0 | nms-nap-compiler-v5.17.0 |
65+
| 4.15.0 | nms-nap-compiler-v5.442.0 |
6466
| 4.14.0 | nms-nap-compiler-v5.342.0 |
6567
| 4.13.0 | nms-nap-compiler-v5.264.0 |
6668
| 4.12.0 | nms-nap-compiler-v5.210.0 |
@@ -86,13 +88,13 @@ The table below shows which WAF compiler version to use for each version of NGIN
8688
To install the WAF compiler on Debian or Ubuntu, run the following command:
8789

8890
```shell
89-
sudo apt-get install nms-nap-compiler-v5.342.0
91+
sudo apt-get install nms-nap-compiler-v5.442.0
9092
```
9193

9294
If you want to install more than one version of the WAF compiler on the same system, append the `--force-overwrite` option to the install command after the first installation:
9395

9496
```shell
95-
sudo apt-get install nms-nap-compiler-v5.342.0 -o Dpkg::Options::="--force-overwrite"
97+
sudo apt-get install nms-nap-compiler-v5.442.0 -o Dpkg::Options::="--force-overwrite"
9698
```
9799

98100
{{< include "nim/nap-waf/restart-nms-integrations.md" >}}
@@ -116,7 +118,7 @@ To install the WAF compiler on RHEL 8.1 or later:
116118
3. Install the WAF compiler:
117119

118120
```shell
119-
sudo yum install nms-nap-compiler-v5.342.0
121+
sudo yum install nms-nap-compiler-v5.442.0
120122
```
121123

122124
4. {{< include "nim/nap-waf/restart-nms-integrations.md" >}}
@@ -140,7 +142,7 @@ To install the WAF compiler on RHEL 7.4 or later or CentOS:
140142
3. Install the WAF compiler:
141143

142144
```shell
143-
sudo yum install nms-nap-compiler-v5.342.0
145+
sudo yum install nms-nap-compiler-v5.442.0
144146
```
145147

146148
4. {{< include "nim/nap-waf/restart-nms-integrations.md" >}}
@@ -167,7 +169,7 @@ To install the WAF compiler on Amazon Linux 2 LTS:
167169
3. Install the WAF compiler:
168170

169171
```shell
170-
sudo yum install nms-nap-compiler-v5.342.0
172+
sudo yum install nms-nap-compiler-v5.442.0
171173
```
172174

173175
4. {{< include "nim/nap-waf/restart-nms-integrations.md" >}}
@@ -192,7 +194,7 @@ To install the WAF compiler on Oracle Linux 7.4 or later:
192194
3. Install the WAF compiler:
193195

194196
```shell
195-
sudo yum install nms-nap-compiler-v5.342.0
197+
sudo yum install nms-nap-compiler-v5.442.0
196198
```
197199

198200
4. {{< include "nim/nap-waf/restart-nms-integrations.md" >}}
@@ -1004,21 +1006,21 @@ sudo /opt/nms-nap-compiler/app_protect-<version>/bin/apcompile -h
10041006
**Example:**
10051007
10061008
```shell
1007-
sudo /opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -h
1009+
sudo /opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -h
10081010
```
10091011
10101012
**Expected output:**
10111013
10121014
```text
10131015
USAGE:
1014-
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile <options>
1016+
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile <options>
10151017
10161018
Examples:
1017-
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -p /path/to/policy.json -o mypolicy.tgz
1018-
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -p policyA.json -g myglobal.json -o /path/to/policyA_bundle.tgz
1019-
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -g myglobalsettings.json --global-state-outfile /path/to/myglobalstate.tgz
1020-
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -b /path/to/policy_bundle.tgz --dump
1021-
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -l logprofA.json -o /path/to/logprofA_bundle.tgz
1019+
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -p /path/to/policy.json -o mypolicy.tgz
1020+
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -p policyA.json -g myglobal.json -o /path/to/policyA_bundle.tgz
1021+
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -g myglobalsettings.json --global-state-outfile /path/to/myglobalstate.tgz
1022+
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -b /path/to/policy_bundle.tgz --dump
1023+
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -l logprofA.json -o /path/to/logprofA_bundle.tgz
10221024
```
10231025
10241026
### Confirm NGINX Agent configuration on the NGINX App Protect WAF instance

0 commit comments

Comments
 (0)