You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _banners/agent-v3-release.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,8 @@
1
1
{{< banner "notice" "NGINX Agent 3.0 is now available" >}}
2
2
3
+
The documentation in this section is for **NGINX Agent version 2.x**. For NGINX Agent 3.x content visit the [NGINX One Console documentation]({{< ref "/nginx-one/agent/" >}})
3
4
4
-
F5 NGINX One Console and NGINX Instance Manager (NIM) do not currently support Agent 3.x. If you are using NGINX One Console or NGINX Instance Manager in your environment, upgrade to the latest Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
5
+
F5 NGINX Instance Manager (NIM) does not currently support NGINX Agent 3.x. NGINX Instance Manager customers can upgrade to the latest NGINX Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
5
6
6
7
Please see the [Technical specifications](/nginx-agent/technical-specifications/) for product compatibility.
You must specify a version tag. The `latest` tag is not supported. Learn more in the [Deploying NGINX and NGINX Plus on Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}) guide.
51
+
You must specify a version tag that matches your distribution. The `latest` tag is not supported. Learn more in the [Deploying NGINX and NGINX Plus on Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}) guide.
Start the Docker container to connect it to NGINX One. Replace `YOUR_NGINX_ONE_DATA_PLANE_KEY_HERE` with your data plane key and `VERSION_TAG` with the version tag you pulled.
65
+
Start the Docker container to connect it to NGINX One. Replace `YOUR_NGINX_ONE_DATA_PLANE_KEY_HERE` with your data plane key and `version-tag` with the version tag you pulled.
Copy file name to clipboardExpand all lines: content/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md
+1-6Lines changed: 1 addition & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -162,14 +162,9 @@ When adding a new NGINX instance that is not yet registered with NGINX One, you
162
162
- From the **OS Type** list, choose the appropriate operating system for your Docker image.
163
163
- After selecting the OS, run the provided command to pull the Docker image.
164
164
165
-
**Note**: Subject to availability, you can modify the `agent: <VERSION_TAG>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agent: r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).
165
+
**Note**: Subject to availability, you can modify the `agentv3:<version-tag>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agentv3:r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).
166
166
167
167
168
-
- From the **OS Type** list, choose the appropriate operating system for your Docker image.
169
-
- After selecting the OS, run the provided command to pull the Docker image.
170
-
171
-
**Note**: Subject to availability, you can modify the `agent: <VERSION_TAG>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agent: r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).
172
-
173
168
10. Run the provided command, which includes the data plane key, in your NGINX instance terminal to start the Docker container.
Copy file name to clipboardExpand all lines: content/nic/configuration/policy-resource.md
+28-1Lines changed: 28 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -175,8 +175,14 @@ condition:
175
175
|Field | Description | Type | Required |
176
176
| ---| ---| ---| --- |
177
177
|``jwt`` | defines a JWT condition to rate limit against. | [ratelimit.condition.jwt](#ratelimitconditionjwt) | No |
178
-
|``default`` | sets the rate limit in this policy to be the default if no conditions are met. In a group of policies with the same JWT condition, only one policy can be the default. | ``bool`` | No |
178
+
|``variables`` | defines a Variable condition to rate limit against. | [ratelimit.condition.variables](#ratelimitconditionvariables) | No |
179
+
|``default`` | sets the rate limit in this policy to be the default if no conditions are met. In a group of policies with the same condition, only one policy can be the default. | ``bool`` | No |
179
180
{{% /table %}}
181
+
{{< note >}}
182
+
183
+
One condition of type `jwt` or `variables` is required. Each Policy supports only one condition.
184
+
185
+
{{< /note >}}
180
186
181
187
The rate limit policy with condition is designed to be used in combination with one or more rate limit policies. For example, multiple rate limit policies with [RateLimit.Condition.JWT](#ratelimitconditionjwt) can be used to apply different tiers of rate limit based on the value of a JWT claim. For a practical example of tiered rate limiting by the value of a JWT claim, see the example in our [GitHub repository](https://github.com/nginx/kubernetes-ingress/tree/v{{< nic-version >}}/examples/custom-resources/rate-limit-tiered-jwt-claim/README.md).
182
188
@@ -213,6 +219,27 @@ The rate limit policy will only apply to requests that contain a JWT with the sp
213
219
|``match`` | the value of the claim to match against. | ``string`` | Yes |
214
220
{{% /table %}}
215
221
222
+
### RateLimit.Condition.Variables
223
+
224
+
RateLimit.Condition.Variables defines a condition for a rate limit by NGINX variable. The following example defines a condition for a rate limit policy that only applies to requests with the request method with a value `GET`:
225
+
226
+
```yaml
227
+
variables:
228
+
- name: $request_method
229
+
match: GET
230
+
```
231
+
232
+
{{< note >}}
233
+
Only one variable at a time is supported at present.
234
+
{{< /note >}}
235
+
236
+
{{% table %}}
237
+
|Field | Description | Type | Required |
238
+
| ---| ---| ---| --- |
239
+
|``name`` | the name of the NGINX variable to be rate limit by. | ``string`` | Yes |
240
+
|``match`` | the value of the NGINX variable to match against. Values prefixed with the `~` character denote the following is a [regular expression](https://nginx.org/en/docs/http/ngx_http_map_module.html#map). | ``string`` | Yes |
241
+
{{% /table %}}
242
+
216
243
### APIKey
217
244
218
245
The API Key auth policy configures NGINX to authorize client requests based on the presence of a valid API Key in a header or query param specified in the policy.
Copy file name to clipboardExpand all lines: content/nic/releases.md
+49Lines changed: 49 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,55 @@ toc: true
5
5
nd-content-type: reference
6
6
nd-product: NIC
7
7
nd-docs: DOCS-616
8
+
---
9
+
## 5.1.0
10
+
11
+
08 Jul 2025
12
+
13
+
This release includes the ability to configure Rate Limiting for your APIs based on a specific NGINX variable and its value. This allows you more granular control over how frequently specific users access your resources.
14
+
15
+
Lastly, in our previous v5.0.0 release, we removed support for Open Tracing. This release replaces that observability capability with native NGINX Open Telemetry traces, allowing you to monitor the internal traffic of your applications.
16
+
17
+
### <iclass="fa-solid fa-rocket"></i> Features
18
+
-[7642](https://github.com/nginx/kubernetes-ingress/pull/7642) Add OpenTelemetry support
19
+
-[7916](https://github.com/nginx/kubernetes-ingress/pull/7916) Add support for Agent V3
20
+
-[7884](https://github.com/nginx/kubernetes-ingress/pull/7884) Tiered rate limits with variables
21
+
-[7765](https://github.com/nginx/kubernetes-ingress/pull/7765) Add OIDC PKCE configuration through Policy
22
+
-[7832](https://github.com/nginx/kubernetes-ingress/pull/7832) Add request_method to rate-limit Policy
23
+
-[7695](https://github.com/nginx/kubernetes-ingress/pull/7695) Add ConfigMapKeys & MGMTConfigMapKeys to Telemetry
24
+
-[7705](https://github.com/nginx/kubernetes-ingress/pull/7705) Add Context to logging for JSON and TEXT formats
25
+
26
+
### <iclass="fa-solid fa-bug-slash"></i> Fixes
27
+
28
+
-[7651](https://github.com/nginx/kubernetes-ingress/pull/7651) Use pod labels as headless selector labels
29
+
-[7691](https://github.com/nginx/kubernetes-ingress/pull/7691) Avoid applying updates on Ingress Controller shutdown
30
+
-[7748](https://github.com/nginx/kubernetes-ingress/pull/7748) Add ; in oidc files
31
+
-[7786](https://github.com/nginx/kubernetes-ingress/pull/7786) Correct namespace for mgmt secrets
32
+
-[7853](https://github.com/nginx/kubernetes-ingress/pull/7853) Update template for custom redirect URI
33
+
-[7865](https://github.com/nginx/kubernetes-ingress/pull/7865) Maintain HeadlessService on upgrade
0 commit comments