Skip to content

Commit a6cfced

Browse files
committed
Merge remote-tracking branch 'origin' into internal/nim-release-2.20.0
2 parents d4c474b + 2f2be34 commit a6cfced

File tree

8 files changed

+67
-7
lines changed

8 files changed

+67
-7
lines changed

_banners/agent-v3-release.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{{< banner "notice" "NGINX Agent 3.0 is now available" >}}
2+
3+
4+
F5 NGINX One Console does not currently support Agent 3.x. If you are using NGINX One Console in your environment, upgrade to the latest Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
5+
6+
Please see the [Technical specifications](/nginx-agent/technical-specifications/) for product compatibility.
7+
8+
9+
{{< /banner >}}

content/agent/_index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
---
22
title: NGINX Agent
3-
description: NGINX Agent is a companion daemon for your NGINX Open Source or NGINX
4-
Plus instance.
53
url: /nginx-agent/
64
cascade:
75
logo: NGINX-product-icon.png
6+
banner:
7+
enabled: true
8+
type: deprecation
9+
start-date: 2025-05-29
10+
end-date: 2025-09-09
11+
md: /_banners/agent-v3-release.md
812
---

content/agent/technical-specifications.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@ type:
1212

1313
This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.
1414

15+
## NGINX Agent v3.0 Compatibility
16+
{{< bootstrap-table "table table-striped table-bordered" >}}
17+
| NGINX Product | Agent Version |
18+
|------------------------------|----------------|
19+
| **NGINX One Console** | 2.x |
20+
| **NGINX Gateway Fabric** | 3.x |
21+
| **NGINX Plus** | 2.x, 3.x |
22+
| **NGINX Ingress Controller** | 2.x |
23+
| **NGINX Instance Manager** | 2.x |
24+
{{< /bootstrap-table >}}
25+
1526
## Supported Distributions
1627

1728
NGINX Agent can run in most environments. We support the following distributions:

content/nginx-one/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ cascade:
4040
{{</ card >}}
4141
{{</ card-section >}}
4242

43-
# Other Products
43+
# Other Components
4444
{{< card-section title="Kubernetes Solutions">}}
4545
{{< card title="NGINX Ingress Controller" titleUrl="/nginx-ingress-controller/" icon="NGINX-Ingress-Controller-product-icon">}}
4646
Kubernetes traffic management with API gateway, identity, and observability features.

content/nginx/fips-compliance-nginx-plus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This statement uses the following terms:
3131

3232
- **Cryptographic module**: The OpenSSL software, comprised of libraries of FIPS‑validated algorithms that can be used by other applications.
3333

34-
- **Cryptographic boundary**: The operational functions that use FIPS‑validated algorithms. For NGINX Plus, the cryptographic boundary includes all functionality that is implemented by the [http_ssl](http://nginx.org/en/docs/http/ngx_http_ssl_module.html), [http_v2](http://nginx.org/en/docs/http/ngx_http_v2_module.html), [stream_ssl](http://nginx.org/en/docs/stream/ngx_stream_ssl_module.html), and [mail_ssl](http://nginx.org/en/docs/mail/ngx_mail_ssl_module.html) modules. These modules implement SSL and TLS operations for inbound and outbound connections which use HTTP, HTTP/2, TCP, and mail protocols.
34+
- **Cryptographic boundary**: The operational functions that use FIPS‑validated algorithms. For NGINX Plus, the cryptographic boundary includes all functionality that is implemented by the [http_ssl](http://nginx.org/en/docs/http/ngx_http_ssl_module.html), [http_v2](http://nginx.org/en/docs/http/ngx_http_v2_module.html), [stream_ssl](http://nginx.org/en/docs/stream/ngx_stream_ssl_module.html), [mail_ssl](http://nginx.org/en/docs/mail/ngx_mail_ssl_module.html), and [http_auth_jwt](http://nginx.org/en/docs/http/ngx_http_auth_jwt_module.html) modules. These modules implement SSL and TLS operations for inbound and outbound connections which use HTTP, HTTP/2, TCP, and mail protocols.
3535

3636
- **NGINX Plus**: The NGINX Plus software application developed by NGINX, Inc. and delivered in binary format from NGINX servers.
3737

content/nginxaas-azure/loadbalancer-kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ The NLK controller can be installed in your Kubernetes cluster using either Helm
148148
Install the NLK controller using `helm install`. Be sure your kubectl context is pointed at the desired cluster.
149149

150150
```bash
151-
helm install nlk oci://registry-1.docker.io/nginxcharts/nginxaas-loadbalancer-kubernetes --version 1.0.0 \
151+
helm install nlk oci://registry-1.docker.io/nginxcharts/nginxaas-loadbalancer-kubernetes --version 1.1.1 \
152152
--set "nlk.dataplaneApiKey=${keyValue}" \
153153
--set "nlk.config.nginxHosts=${dataplaneAPIEndpoint}nplus"
154154
```

content/nginxaas-azure/monitoring/enable-monitoring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Monitoring your application's performance is crucial for maintaining its reliabi
1212

1313
Refer to the [Azure monitor overview](https://docs.microsoft.com/en-us/azure/azure-monitor/overview) documentation from Microsoft to learn more about Azure Monitor.
1414

15-
### Prerequisites
15+
## Prerequisites
1616

1717
- A system assigned managed identity with `Monitoring Metrics Publisher` role.
1818

@@ -25,7 +25,7 @@ Azure Monitor will collects metrics from the NGINXaaS deployment automatically i
2525
## Exporting
2626
You can export Azure Monitor metrics to other destinations like Log Analytics workspace, Azure Storage Account, Azure Event Hubs or Azure Monitor partner solutions using Diagnostic Setting. For more information, see the [Metrics diagnostic setting](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings).
2727

28-
To configure diagnostic settings for a service, see [Create diagnostic settings in Azure Monitor](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/create-diagnostic-settings).
28+
To configure diagnostic settings for a service, see [Create diagnostic settings in Azure Monitor](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/create-diagnostic-settings). You can export metrics by selecting the `AllMetrics` category in diagnostic settings.
2929

3030
{{<note>}} Not all metrics are exportable via diagnostic settings, for a list of exportable metrics, see [NGINXaaS exportable metrics](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/nginx-nginxplus-nginxdeployments-metrics).{{</note>}}
3131

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Migrate from Custom metrics to Platform metrics
3+
weight: 1000
4+
toc: true
5+
url: /nginxaas/azure/getting-started/migrate-to-platform-metrics/
6+
type:
7+
- how-to
8+
---
9+
10+
## Overview
11+
12+
F5 NGINXaaS for Azure previously supported monitoring through [Custom Metrics](https://learn.microsoft.com/en-us/azure/azure-monitor/metrics/metrics-custom-overview), which is a preview feature in Azure. As a preview feature, support for Custom Metrics will be removed in the future. We've added support for Platform Metrics, which is the recommended way to monitor resources in Azure. We strongly recommend switching your deployment's monitoring to Platform Metrics to take advantage of lower latency and better reliability.
13+
14+
## Migration steps
15+
16+
Follow the steps in this section to migrate your deployment monitoring from Custom metrics to Platform metrics.
17+
18+
1. Verify that your NGINXaaS deployment meets the [pre-requisites]({{< ref "/nginxaas-azure/monitoring/enable-monitoring.md#prerequisites">}}) for Platform metrics to work.
19+
2. If the pre-requisites are met, Platform metrics are enabled by default on all NGINXaaS deployment. Verify that you are able to see the new metrics in Azure Monitor under the `Standard Metrics` namespace.
20+
3. Turn off legacy monitoring:
21+
22+
- Using the Azure portal
23+
1. In the Azure portal, go to the **NGINX monitoring** page for your NGINXaaS deployment.
24+
2. Turn off the **Send metrics to Azure Monitor** setting.
25+
3. Select **Save**.
26+
27+
- Using Terraform
28+
1. Set `diagnose_support_enabled` to false in the `azurerm_nginx_deployment` resource.
29+
2. Run `terraform plan` followed by `terraform apply` to upgrade the deployment.
30+
31+
- Using the Azure CLI
32+
Run the following command:
33+
```shell
34+
az nginx deployment update --name myDeployment --resource-group \
35+
myResourceGroup --enable-diagnostics="false"
36+
```

0 commit comments

Comments
 (0)