Skip to content

Commit fda0b56

Browse files
committed
feat: Fix links
1 parent 8664251 commit fda0b56

File tree

3 files changed

+9
-16
lines changed

3 files changed

+9
-16
lines changed

config/_default/config.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ enableGitInfo = true
2020
nim = '/nginx-instance-manager/:sections[1:]/:contentbasename'
2121
nms = '/nginx-management-suite/:sections[1:]/:contentbasename'
2222
unit = '/nginx-unit/:sections[1:]/:contentbasename'
23+
waf = '/waf/:sections[1:]/:contentbasename'
2324

2425
[caches]
2526
[caches.modules]

content/includes/nic/configuration/policy-resource.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ spec:
4343
|``jwt`` | The JWT policy configures NGINX Plus to authenticate client requests using JSON Web Tokens. | [jwt](#jwt) | No |
4444
|``ingressMTLS`` | The IngressMTLS policy configures client certificate verification. | [ingressMTLS](#ingressmtls) | No |
4545
|``egressMTLS`` | The EgressMTLS policy configures upstreams authentication and certificate verification. | [egressMTLS](#egressmtls) | No |
46-
|``waf`` | The WAF policy configures WAF and log configuration policies for [NGINX AppProtect]({{< relref "installation/integrations/app-protect-waf/configuration.md" >}}) | [WAF](#waf) | No |
46+
|``waf`` | The WAF policy configures WAF and log configuration policies for [NGINX AppProtect]({{< ref "/nic/installation/integrations/app-protect-waf/configuration.md" >}}) | [WAF](#waf) | No |
4747
{{% /table %}}
4848
4949
\* A policy must include exactly one policy.
@@ -121,7 +121,7 @@ The feature is implemented using the NGINX [ngx_http_limit_req_module](https://n
121121

122122
{{< call-out "note" >}}
123123

124-
When the [Zone Sync feature]({{< ref "/configuration/global-configuration/configmap-resource.md#zone-sync" >}}) is enabled with NGINX Plus, the rate limiting zone will be synchronized across all replicas in the cluster. This means all replicas are aware of the requests that have been rate limited by other replicas in the cluster.
124+
When the [Zone Sync feature]({{< ref "/nic/configuration/global-configuration/configmap-resource.md#zone-sync" >}}) is enabled with NGINX Plus, the rate limiting zone will be synchronized across all replicas in the cluster. This means all replicas are aware of the requests that have been rate limited by other replicas in the cluster.
125125

126126
{{< /call-out >}}
127127

@@ -137,7 +137,7 @@ When the [Zone Sync feature]({{< ref "/configuration/global-configuration/config
137137
|``dryRun`` | Enables the dry run mode. In this mode, the rate limit is not actually applied, but the number of excessive requests is accounted as usual in the shared memory zone. | ``bool`` | No |
138138
|``logLevel`` | Sets the desired logging level for cases when the server refuses to process requests due to rate exceeding, or delays request processing. Allowed values are ``info``, ``notice``, ``warn`` or ``error``. Default is ``error``. | ``string`` | No |
139139
|``rejectCode`` | Sets the status code to return in response to rejected requests. Must fall into the range ``400..599``. Default is ``503``. | ``int`` | No |
140-
|``scale`` | Enables a constant rate-limit by dividing the configured rate by the number of nginx-ingress pods currently serving traffic. This adjustment ensures that the rate-limit remains consistent, even as the number of nginx-pods fluctuates due to autoscaling. **This will not work properly if requests from a client are not evenly distributed across all ingress pods** (Such as with sticky sessions, long lived TCP Connections with many requests, and so forth). In such cases using [zone-sync]({{< ref "/configuration/global-configuration/configmap-resource.md#zone-sync" >}}) instead would give better results. Enabling `zone-sync` will suppress this setting. | ``bool`` | No |
140+
|``scale`` | Enables a constant rate-limit by dividing the configured rate by the number of nginx-ingress pods currently serving traffic. This adjustment ensures that the rate-limit remains consistent, even as the number of nginx-pods fluctuates due to autoscaling. **This will not work properly if requests from a client are not evenly distributed across all ingress pods** (Such as with sticky sessions, long lived TCP Connections with many requests, and so forth). In such cases using [zone-sync]({{< ref "/nic/configuration/global-configuration/configmap-resource.md#zone-sync" >}}) instead would give better results. Enabling `zone-sync` will suppress this setting. | ``bool`` | No |
141141
|``condition`` | Add a condition to a rate-limit policy. | [ratelimit.condition](#ratelimitcondition) | No |
142142
{{% /table %}}
143143

@@ -734,7 +734,7 @@ For `kubectl get` and similar commands, you can also use the short name `pol` in
734734

735735
### WAF {#waf}
736736

737-
{{< call-out "note" >}} The feature is implemented using the NGINX Plus [F5 WAF for NGINX Module](https://docs.nginx.com/nginx-app-protect/configuration/). {{< /call-out >}}
737+
{{< call-out "note" >}} The feature is implemented using [F5 WAF for NGINX]({{< ref "/waf/" >}}). {{< /call-out >}}
738738

739739
The WAF policy configures NGINX Plus to secure client requests using F5 WAF for NGINX policies.
740740

@@ -759,11 +759,11 @@ waf:
759759
|Field | Description | Type | Required |
760760
| ---| ---| ---| --- |
761761
|``enable`` | Enables F5 WAF for NGINX. | ``bool`` | Yes |
762-
|``apPolicy`` | The [F5 WAF for NGINX policy]({{< relref "installation/integrations/app-protect-waf/configuration.md#waf-policies" >}}) of the WAF. Accepts an optional namespace. Mutually exclusive with ``apBundle``. | ``string`` | No |
763-
|``apBundle`` | The [F5 WAF for NGINX policy bundle]({{< relref "installation/integrations/app-protect-waf/configuration.md#waf-bundles" >}}). Mutually exclusive with ``apPolicy``. | ``string`` | No |
762+
|``apPolicy`` | The [F5 WAF for NGINX policy]({{< ref "/nic/installation/integrations/app-protect-waf/configuration.md#waf-policies" >}}) of the WAF. Accepts an optional namespace. Mutually exclusive with ``apBundle``. | ``string`` | No |
763+
|``apBundle`` | The [F5 WAF for NGINX policy bundle]({{< ref "/nic/installation/integrations/app-protect-waf/configuration.md#waf-bundles" >}}). Mutually exclusive with ``apPolicy``. | ``string`` | No |
764764
|``securityLog.enable`` | Enables security log. | ``bool`` | No |
765-
|``securityLog.apLogConf`` | The [F5 WAF for NGINX log conf]({{< relref "installation/integrations/app-protect-waf/configuration.md#waf-logs" >}}) resource. Accepts an optional namespace. Only works with ``apPolicy``. | ``string`` | No |
766-
|``securityLog.apLogBundle`` | The [F5 WAF for NGINX log bundle]({{< relref "installation/integrations/app-protect-waf/configuration.md#waf-bundles" >}}) resource. Only works with ``apBundle``. | ``string`` | No |
765+
|``securityLog.apLogConf`` | The [F5 WAF for NGINX log conf]({{< ref "/nic/installation/integrations/app-protect-waf/configuration.md#waf-logs" >}}) resource. Accepts an optional namespace. Only works with ``apPolicy``. | ``string`` | No |
766+
|``securityLog.apLogBundle`` | The [F5 WAF for NGINX log bundle]({{< ref "/nic/installation/integrations/app-protect-waf/configuration.md#waf-bundles" >}}) resource. Only works with ``apBundle``. | ``string`` | No |
767767
|``securityLog.logDest`` | The log destination for the security log. Only accepted variables are ``syslog:server=<ip-address &#124; localhost; fqdn>:<port>``, ``stderr``, ``<absolute path to file>``. | ``string`` | No |
768768
{{% /table %}}
769769

content/waf/policies/configuration.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,6 @@ nd-content-type: how-to
1212
nd-product: NAP-WAF
1313
---
1414

15-
{{< call-out "warning" "Information architecture note" >}}
16-
17-
The design intention for this page is to as a single source of truth to replace the two [Configuration]({{< ref "/nap-waf/v4/configuration-guide/configuration.md" >}}) [Guides]({{< ref "/nap-waf/v5/configuration-guide/configuration.md" >}}) (two separate links).
18-
19-
Outside of the overlapping information for Policy configuration, the existing pages also include general configuration information, such as for F5 WAF for NGINX itself. This detail can be added to a separate page, ensuring that each document acts as a solution for exactly one problem at a time.
20-
21-
{{</ call-out >}}
22-
2315
This page describes the security features available with F5 WAF for NGINX and how to configure policies.
2416

2517
For better understanding of some contextual nouns, read the [Terminology]({{< ref "/waf/fundamentals/terminology.md" >}}) topic.

0 commit comments

Comments
 (0)