Skip to content

Commit 6af3515

Browse files
authored
Merge branch 'main' into docs/update-new-instructions
2 parents 31227ea + 2863c42 commit 6af3515

File tree

3 files changed

+31
-15
lines changed

3 files changed

+31
-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.1 | Release 4.8.0–4.13.0, 5.1.0–5.5.0 |
11+
| 2.17.0–2.19.1 | Release 4.8.0–4.14.0, 5.1.0–5.6.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/nginxaas-azure/quickstart/loadbalancer-kubernetes.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ The steps in this section must be completed once for each new setup. We will ins
7171

7272
{{<note>}}
7373
The data plane API key has the following requirements:
74+
7475
- The key should have an expiration date. The default expiration date is six months from the date of creation. The expiration date cannot be longer than two years from the date of creation.
7576
- The key should be at least 12 characters long.
7677
- The key requires three out of four of the following types of characters:
@@ -184,6 +185,7 @@ You can also install the NLK controller AKS extension by navigating to [F5 NGINX
184185
- On the **Basics** tab, provide the following information:
185186

186187
{{<bootstrap-table "table table-striped table-bordered">}}
188+
187189
| Field | Description |
188190
|---------------------------- | ---------------------------- |
189191
| Subscription | Select the appropriate Azure subscription. |
@@ -194,6 +196,7 @@ You can also install the NLK controller AKS extension by navigating to [F5 NGINX
194196
- Select **Application Details**, and provide the following information:
195197

196198
{{<bootstrap-table "table table-striped table-bordered">}}
199+
197200
| Field | Description |
198201
|---------------------------- | ---------------------------- |
199202
| Cluster extension resource name | Provide a name for the NLK controller. |
@@ -247,10 +250,18 @@ Expose a Kubernetes `Service` to route traffic to your workload. The `Service`
247250
- Choose one of the following `Service` types:
248251
- `NodePort`: To route external traffic into the cluster using a well defined port exposed on each AKS worker node.
249252
- `ClusterIP`: To route traffic to pods directly if you are running an Azure Container Networking Interface (CNI) that lets you expose the pods on the Azure VNET.
253+
- `LoadBalancer`: To route traffic to the cluster's external load balancer. The load balancer routes traffic into the cluster as normal.
250254
- The port name must be formatted as `{{NGINX Context}}-{{NGINX upstream name}}`. For example:
251255
- If the upstream is in the `http` context and named `my-service` then the name is `http-my-service`
252256
- If the upstream is in the `stream` context and named `jet` then the port name is `stream-jet`
253257

258+
{{< note >}}
259+
**NGINX Ingress Controller users**: with v5.0.0 and upwards, if you wish to route traffic from your NGINXaaS deployment to your NGINX Ingress Controller service, please make the following changes to your helm chart values:
260+
261+
- Add `"nginx.com/nginxaas": "nginxaas"` to the NGINX Ingress Controller service annotations.
262+
- Modify the `service.httpPort.name` or `service.httpsPort.name` values to provide the expected port name format, as above.
263+
{{</ note >}}
264+
254265
The following example uses a service of type `NodePort`:
255266

256267
```yaml
@@ -331,6 +342,7 @@ flowchart TB
331342
```
332343

333344
{{<note>}}
345+
334346
- Configuring multiple NLK controllers to update the same upstream isn't supported and will result in unpredictable behavior.
335347
{{</note>}}
336348

@@ -341,6 +353,7 @@ Multiple NLK controllers can be installed in the same AKS cluster to update sepa
341353
Each NLK needs a unique helm release name and needs a unique helm value for `nlk.config.serviceAnnotationMatch`. Each NLK will only watch services that have the matching annotation.
342354

343355
{{<note>}}
356+
344357
- Consider using `helm` to install multiple NLK controllers on an AKS cluster. Installing multiple copies of the controller on the same AKS cluster is not supported via the [AKS Extension](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/f5-networks.f5-nginx-for-azure-aks-extension?tab=overview).
345358
{{</note>}}
346359

@@ -361,6 +374,7 @@ The logs can be made more verbose by setting the Helm value `nlk.config.logLevel
361374
NGINXaaS supports exporting dynamic upstream update logs to an Azure Storage account or to a Log Analytics workspace.
362375

363376
To setup logging:
377+
364378
1. Select **Diagnostic settings** under **Monitoring**.
365379
1. Select **Add diagnostic setting**.
366380
1. On the following panel, provide a **Diagnostic setting name**.

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

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,13 @@ The following table shows the NGINX App Protect WAF Release version and its corr
5353

5454
| NGINX App Protect WAF Release version | WAF Compiler |
5555
|---------------------------------------|----------------------------|
56+
| NGINX App Protect WAF 5.6.0 | nms-nap-compiler-v5.342.0 |
5657
| NGINX App Protect WAF 5.5.0 | nms-nap-compiler-v5.264.0 |
5758
| NGINX App Protect WAF 5.4.0 | nms-nap-compiler-v5.210.0 |
5859
| NGINX App Protect WAF 5.3.0 | nms-nap-compiler-v5.144.0 |
5960
| NGINX App Protect WAF 5.2.0 | nms-nap-compiler-v5.48.0 |
6061
| NGINX App Protect WAF 5.1.0 | nms-nap-compiler-v5.17.0 |
62+
| NGINX App Protect WAF 4.14.0 | nms-nap-compiler-v5.342.0 |
6163
| NGINX App Protect WAF 4.13.0 | nms-nap-compiler-v5.264.0 |
6264
| NGINX App Protect WAF 4.12.0 | nms-nap-compiler-v5.210.0 |
6365
| NGINX App Protect WAF 4.11.0 | nms-nap-compiler-v5.144.0 |
@@ -95,15 +97,15 @@ The following table shows the NGINX App Protect WAF Release version and its corr
9597
Install the WAF compiler, then restart the `nms-integrations` service:
9698

9799
```bash
98-
sudo apt-get install nms-nap-compiler-v5.264.0
100+
sudo apt-get install nms-nap-compiler-v5.342.0
99101
```
100102

101103
{{<note>}}
102104

103105
- If you want to have more than one version of the `nms-nap-compiler` installed on your system at once, you'll need to append `-o Dpkg::Options::="--force-overwrite"` to the `nms-nap-compiler` installation commands after your initial `nms-nap-compiler` installation. For example, the installation command would look like this:
104106

105107
```bash
106-
sudo apt-get install nms-nap-compiler-v5.264.0 -o Dpkg::Options::="--force-overwrite"
108+
sudo apt-get install nms-nap-compiler-v5.342.0 -o Dpkg::Options::="--force-overwrite"
107109
```
108110

109111
{{</note>}}
@@ -115,7 +117,7 @@ Download the file dependencies.repo to `/etc/yum.repos.d`, enable the `codeready
115117
```bash
116118
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/dependencies.repo
117119
sudo subscription-manager repos --enable codeready-builder-for-rhel-8-x86_64-rpms
118-
sudo yum install nms-nap-compiler-v5.264.0
120+
sudo yum install nms-nap-compiler-v5.342.0
119121
```
120122

121123
### RHEL 7.4 or later; CentOS
@@ -124,7 +126,7 @@ Download the file `dependencies.repo` to `/etc/yum.repos.d`, enable the RHEL 7 s
124126
```bash
125127
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/dependencies.repo
126128
sudo yum-config-manager --enable rhui-REGION-rhel-server-optional rhui-REGION-rhel-server-releases rhel-7-server-optional-rpms
127-
sudo yum install nms-nap-compiler-v5.264.0
129+
sudo yum install nms-nap-compiler-v5.342.0
128130
```
129131

130132
### Amazon Linux 2 LTS
@@ -136,7 +138,7 @@ sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/app-protect-7.re
136138
sudo amazon-linux-extras enable epel
137139
sudo yum clean metadata
138140
sudo yum install epel-release
139-
sudo yum install nms-nap-compiler-v5.264.0
141+
sudo yum install nms-nap-compiler-v5.342.0
140142
```
141143

142144
### Oracle Linux 7.4 or later
@@ -145,7 +147,7 @@ Download the file `dependencies.repo` to `/etc/yum.repos.d`, enable the `ol8_cod
145147
```bash
146148
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/dependencies.repo
147149
sudo yum-config-manager --enable ol8_codeready_builder
148-
sudo yum install nms-nap-compiler-v5.264.0
150+
sudo yum install nms-nap-compiler-v5.342.0
149151
```
150152

151153
### Download from MyF5
@@ -1088,24 +1090,24 @@ Check if the WAF compiler has been installed and is working properly by viewing
10881090
sudo /opt/nms-nap-compiler/app_protect-<version>/bin/apcompile -h
10891091
```
10901092

1091-
For example, to view the help description for WAF compiler 5.264.0, run the following command:
1093+
For example, to view the help description for WAF compiler 5.342.0, run the following command:
10921094

10931095
``` bash
1094-
sudo /opt/nms-nap-compiler/app_protect-5.264.0/bin/apcompile -h
1096+
sudo /opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -h
10951097
```
10961098

10971099
The output looks similar to the following example:
10981100

10991101
```text
11001102
USAGE:
1101-
/opt/nms-nap-compiler/app_protect-5.264.0/bin/apcompile <options>
1103+
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile <options>
11021104
11031105
Examples:
1104-
/opt/nms-nap-compiler/app_protect-5.264.0/bin/apcompile -p /path/to/policy.json -o mypolicy.tgz
1105-
/opt/nms-nap-compiler/app_protect-5.264.0/bin/apcompile -p policyA.json -g myglobal.json -o /path/to/policyA_bundle.tgz
1106-
/opt/nms-nap-compiler/app_protect-5.264.0/bin/apcompile -g myglobalsettings.json --global-state-outfile /path/to/myglobalstate.tgz
1107-
/opt/nms-nap-compiler/app_protect-5.264.0/bin/apcompile -b /path/to/policy_bundle.tgz --dump
1108-
/opt/nms-nap-compiler/app_protect-5.264.0/bin/apcompile -l logprofA.json -o /path/to/logprofA_bundle.tgz
1106+
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -p /path/to/policy.json -o mypolicy.tgz
1107+
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -p policyA.json -g myglobal.json -o /path/to/policyA_bundle.tgz
1108+
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -g myglobalsettings.json --global-state-outfile /path/to/myglobalstate.tgz
1109+
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -b /path/to/policy_bundle.tgz --dump
1110+
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -l logprofA.json -o /path/to/logprofA_bundle.tgz
11091111
...
11101112
```
11111113

0 commit comments

Comments
 (0)