From 74e524be695dd55cce4424724bba39576099f1ad Mon Sep 17 00:00:00 2001 From: Jon Cahill-Torre Date: Tue, 8 Apr 2025 18:25:02 +0100 Subject: [PATCH 1/5] docs: update agent v3 tech specs --- content/agent/technical-specifications.md | 70 +++---------------- .../nginx-plus/supported-distributions.md | 20 ++++++ content/nginx/technical-specs.md | 31 +++----- 3 files changed, 38 insertions(+), 83 deletions(-) create mode 100644 content/includes/nginx-plus/supported-distributions.md diff --git a/content/agent/technical-specifications.md b/content/agent/technical-specifications.md index 5bcd11efc..4270fc2b8 100644 --- a/content/agent/technical-specifications.md +++ b/content/agent/technical-specifications.md @@ -5,69 +5,19 @@ weight: 700 docs: DOCS-000 --- -## Overview +NGINX Agent is designed to operate efficiently on any system that meets the standard +hardware requirements for running NGINX itself. This ensures compatibility, stability, +and performance aligned with the NGINX core platform: -This document outlines the technical specifications for the F5 NGINX Agent, including details on supported operating systems, deployment environments, compatible NGINX versions, minimum system sizing requirements, and logging considerations. +### Supported distributions ---- - -## Supported Distributions - -The NGINX Agent is versatile and can operate across various environments. Currently, the following distributions are supported: - -| Distribution | Supported Versions | Architectures | -|------------------------------------|---------------------------------------|---------------------| -| **AlmaLinux** | 8, 9 | x86_64, aarch64 | -| **Alpine Linux** | 3.16, 3.17, 3.18, 3.19 | x86_64, aarch64 | -| **Amazon Linux** | 2023 | x86_64, aarch64 | -| **Amazon Linux 2** | LTS | x86_64, aarch64 | -| **CentOS** | 7.4+ | x86_64, aarch64 | -| **Debian** | 11, 12 | x86_64, aarch64 | -| **Oracle Linux** | 7.4+, 8.1+, 9 | x86_64 | -| **Red Hat Enterprise Linux (RHEL)**| 7.4+, 8.1+, 9.0+ | x86_64, aarch64 | -| **Rocky Linux** | 8, 9 | x86_64, aarch64 | -| **SUSE Linux Enterprise Server (SLES)** | 12 SP5, 15 SP2 | x86_64 | -| **Ubuntu** | 20.04 LTS, 22.04 LTS | x86_64, aarch64 | - ---- - -## Supported Deployment Environments - -The NGINX Agent supports deployment in the following environments: - -- **Bare Metal** machines -- **Containers** -- **Public Cloud** platforms, including AWS, Google Cloud Platform, and Microsoft Azure -- **Virtual Machines** - ---- - -## Supported NGINX Versions - -The NGINX Agent is compatible with all supported releases of NGINX Open Source and NGINX Plus. - ---- - -## Minimum System Requirements - -Below are the recommended minimum system specifications for running the NGINX Agent: - -| **Resource** | **Minimum Requirement** | -|--------------|--------------------------| -| **CPU** | 1 CPU core | -| **Memory** | 1 GB RAM | -| **Network** | 1 GbE NIC | -| **Storage** | 20 GB | - ---- - -## Logging +{{< include "nginx-plus/supported-distributions.md" >}} -The NGINX Agent uses log files in standardized formats to collect metrics. As the number of log formats or instances grows, the size of these log files will increase correspondingly. +To see the detailed technical specifications for NGINX, refer to the official +[NGINX documentation]({{< ref "/nginx/technical-specs.md" >}}). -To avoid system storage constraints caused by expanding log directories, it is recommended to: -- Set up a **dedicated partition** for `/var/log/nginx-agent`. -- Enable **[log rotation](https://linux.die.net/man/8/logrotate)** to manage log file growth effectively. +### Recommended hardware -For additional details on managing logs, refer to the [Configuration Overview]({{< relref "/agent/how-to/configuration-overview.md#logs" >}}). \ No newline at end of file +For recommended hardware, see the +[Sizing guide for deploying NGINX Plus on bare metal servers](https://www.f5.com/pdf/deployment-guide/Sizing-Guide-for-Deploying-NGINX-Plus-on-Bare-Metal-Servers-2019-11-09.pdf). diff --git a/content/includes/nginx-plus/supported-distributions.md b/content/includes/nginx-plus/supported-distributions.md new file mode 100644 index 000000000..86439439b --- /dev/null +++ b/content/includes/nginx-plus/supported-distributions.md @@ -0,0 +1,20 @@ +--- +docs: +--- + +{{}} +| Distribution | Supported on R33 | Supported on R32 | +|-------------------------------------|-----------------------------------------------|-----------------------------------------------| +| AlmaLinux | 8 (x86_64, aarch64)
9 (x86_64, aarch64) | 8 (x86_64, aarch64)
9 (x86_64, aarch64) | +| Alpine Linux | 3.17 (x86_64, aarch64) **(deprecated)**
3.18 (x86_64, aarch64)
3.19 (x86_64, aarch64)
3.20 (x86_64, aarch64) **(new)** | 3.16 (x86_64, aarch64) **(deprecated)**
3.17 (x86_64, aarch64)
3.18 (x86_64, aarch64)
3.19 (x86_64, aarch64) | +| Amazon Linux | 2023 (x86_64, aarch64) | 2023 (x86_64, aarch64) | +| Amazon Linux 2 | LTS (x86_64, aarch64) | LTS (x86_64, aarch64) | +| CentOS | **Not supported** | 7.4+ (x86_64) **(deprecated)** | +| Debian | 11 (x86_64, aarch64)
12 (x86_64, aarch64) | 11 (x86_64, aarch64)
12 (x86_64, aarch64) | +| FreeBSD | 13 (amd64)
14 (amd64) | 13 (amd64)
14 (amd64) | +| Oracle Linux | 8.1+ (x86_64, aarch64)
9 (x86_64) | 7.4+ (x86_64) **(deprecated)**
8.1+ (x86_64, aarch64)
9 (x86_64) | +| Red Hat Enterprise Linux (RHEL) | 8.1+ (x86_64, aarch64)
9.0+ (x86_64, aarch64) | 7.4+ (x86_64) **(deprecated)**
8.1+ (x86_64, aarch64)
9.0+ (x86_64, aarch64) | +| Rocky Linux | 8 (x86_64, aarch64)
9 (x86_64, aarch64) | 8 (x86_64, aarch64)
9 (x86_64, aarch64) | +| SUSE Linux Enterprise Server (SLES) | 12 SP5 (x86_64) **(deprecated)**
15 SP2+ (x86_64) | 12 SP5 (x86_64)
15 SP2+ (x86_64) | +| Ubuntu | 20.04 LTS (x86_64, aarch64)
22.04 LTS (x86_64, aarch64)
24.04 LTS (x86_64, aarch64) | 20.04 LTS (x86_64, aarch64)
22.04 LTS (x86_64, aarch64)
24.04 LTS (x86_64, aarch64 **(new)** | +{{}} \ No newline at end of file diff --git a/content/nginx/technical-specs.md b/content/nginx/technical-specs.md index 51401b3fa..0a24a6f45 100644 --- a/content/nginx/technical-specs.md +++ b/content/nginx/technical-specs.md @@ -14,22 +14,7 @@ NGINX Plus is available only as a binary; it is not distributed as source code. ## Supported Distributions {#supported-distributions} -{{}} -| Distribution | Supported on R33 | Supported on R32 | -|-------------------------------------|-----------------------------------------------|-----------------------------------------------| -| AlmaLinux | 8 (x86_64, aarch64)
9 (x86_64, aarch64) | 8 (x86_64, aarch64)
9 (x86_64, aarch64) | -| Alpine Linux | 3.17 (x86_64, aarch64) **(deprecated)**
3.18 (x86_64, aarch64)
3.19 (x86_64, aarch64)
3.20 (x86_64, aarch64) **(new)** | 3.16 (x86_64, aarch64) **(deprecated)**
3.17 (x86_64, aarch64)
3.18 (x86_64, aarch64)
3.19 (x86_64, aarch64) | -| Amazon Linux | 2023 (x86_64, aarch64) | 2023 (x86_64, aarch64) | -| Amazon Linux 2 | LTS (x86_64, aarch64) | LTS (x86_64, aarch64) | -| CentOS | **Not supported** | 7.4+ (x86_64) **(deprecated)** | -| Debian | 11 (x86_64, aarch64)
12 (x86_64, aarch64) | 11 (x86_64, aarch64)
12 (x86_64, aarch64) | -| FreeBSD | 13 (amd64)
14 (amd64) | 13 (amd64)
14 (amd64) | -| Oracle Linux | 8.1+ (x86_64, aarch64)
9 (x86_64) | 7.4+ (x86_64) **(deprecated)**
8.1+ (x86_64, aarch64)
9 (x86_64) | -| Red Hat Enterprise Linux (RHEL) | 8.1+ (x86_64, aarch64)
9.0+ (x86_64, aarch64) | 7.4+ (x86_64) **(deprecated)**
8.1+ (x86_64, aarch64)
9.0+ (x86_64, aarch64) | -| Rocky Linux | 8 (x86_64, aarch64)
9 (x86_64, aarch64) | 8 (x86_64, aarch64)
9 (x86_64, aarch64) | -| SUSE Linux Enterprise Server (SLES) | 12 SP5 (x86_64) **(deprecated)**
15 SP2+ (x86_64) | 12 SP5 (x86_64)
15 SP2+ (x86_64) | -| Ubuntu | 20.04 LTS (x86_64, aarch64)
22.04 LTS (x86_64, aarch64)
24.04 LTS (x86_64, aarch64) | 20.04 LTS (x86_64, aarch64)
22.04 LTS (x86_64, aarch64)
24.04 LTS (x86_64, aarch64 **(new)** | -{{}} +{{< include "nginx-plus/supported-distributions.md" >}} --- @@ -54,13 +39,13 @@ Dynamic modules are supported on the [same distributions as NGINX Plus](#support ## Supported SSL/TLS versions -NGINX Plus supports the following SSL/TLS protocols: -- SSLv2 -- SSLv3 -- TLSv1 -- TLSv1.1 -- TLSv1.2 -- TLSv1.3 +NGINX Plus supports the following SSL/TLS protocols: +- SSLv2 +- SSLv3 +- TLSv1 +- TLSv1.1 +- TLSv1.2 +- TLSv1.3 You can configure which protocols to enable or disable with the [ssl_protocols](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_protocols) directive. From d7101712ab8d428e66a985de00595bc5f7f8b142 Mon Sep 17 00:00:00 2001 From: Jon Cahill-Torre Date: Wed, 9 Apr 2025 12:14:49 +0100 Subject: [PATCH 2/5] docs: fix moved v2 path --- .../v2/installation-upgrade/installation-unprivileged.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/agent/v2/installation-upgrade/installation-unprivileged.md b/content/agent/v2/installation-upgrade/installation-unprivileged.md index 137bdf752..e32029d9d 100644 --- a/content/agent/v2/installation-upgrade/installation-unprivileged.md +++ b/content/agent/v2/installation-upgrade/installation-unprivileged.md @@ -29,12 +29,12 @@ The installation process involves installing NGINX Plus without root privileges You can install NGINX Plus without root privileges following the steps on the [NGINX Plus installation page]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus/#unpriv_install" >}}). The steps include a script that will allow you to install NGINX Plus in a non-root environment. {{< note >}} -NGINX Agent has its own user group (`nginx-agent`) which is created when NGINX Agent is installed. The user NGINX is running under is added to this user group during the installation of NGINX Agent. If you change the NGINX user after installing NGINX Agent, you will need to [manually add the new NGINX user]({{< ref "/agent/configuration/configure-nginx-agent-group.md" >}}) to the `nginx-agent` group. +NGINX Agent has its own user group (`nginx-agent`) which is created when NGINX Agent is installed. The user NGINX is running under is added to this user group during the installation of NGINX Agent. If you change the NGINX user after installing NGINX Agent, you will need to [manually add the new NGINX user]({{< ref "/agent/v2/configuration/configure-nginx-agent-group.md" >}}) to the `nginx-agent` group. {{< /note >}} ### Install NGINX Agent -After installing NGINX Plus, you can install NGINX agent following the steps on the [NGINX Agent installation page]({{< ref "/agent/installation-upgrade/installation-oss.md" >}}). +After installing NGINX Plus, you can install NGINX agent following the steps on the [NGINX Agent installation page]({{< ref "/agent/v2/installation-upgrade/installation-oss.md" >}}). ### Start NGINX Agent From ebe1b807308928db7f827b0eb234014037287c75 Mon Sep 17 00:00:00 2001 From: Jon Torre <78599298+JTorreG@users.noreply.github.com> Date: Wed, 9 Apr 2025 12:37:15 +0100 Subject: [PATCH 3/5] Update content/agent/technical-specifications.md Co-authored-by: yar --- content/agent/technical-specifications.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/agent/technical-specifications.md b/content/agent/technical-specifications.md index 4270fc2b8..92b62c4dd 100644 --- a/content/agent/technical-specifications.md +++ b/content/agent/technical-specifications.md @@ -13,7 +13,7 @@ and performance aligned with the NGINX core platform: {{< include "nginx-plus/supported-distributions.md" >}} -To see the detailed technical specifications for NGINX, refer to the official +To see the detailed technical specifications for NGINX Plus, refer to the official [NGINX documentation]({{< ref "/nginx/technical-specs.md" >}}). From d1369dd924dfca43fb7ae03f4a47e8593f604a47 Mon Sep 17 00:00:00 2001 From: Jon Torre <78599298+JTorreG@users.noreply.github.com> Date: Wed, 9 Apr 2025 12:37:22 +0100 Subject: [PATCH 4/5] Update content/agent/technical-specifications.md Co-authored-by: yar --- content/agent/technical-specifications.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/agent/technical-specifications.md b/content/agent/technical-specifications.md index 92b62c4dd..04871a2a6 100644 --- a/content/agent/technical-specifications.md +++ b/content/agent/technical-specifications.md @@ -6,7 +6,7 @@ docs: DOCS-000 --- NGINX Agent is designed to operate efficiently on any system that meets the standard -hardware requirements for running NGINX itself. This ensures compatibility, stability, +hardware requirements for running NGINX Plus itself. This ensures compatibility, stability, and performance aligned with the NGINX core platform: ### Supported distributions From 8f03c0dbbccdbc8f691422dcdc6ab5e650adb5c2 Mon Sep 17 00:00:00 2001 From: Jon Torre <78599298+JTorreG@users.noreply.github.com> Date: Wed, 9 Apr 2025 12:37:30 +0100 Subject: [PATCH 5/5] Update content/agent/technical-specifications.md Co-authored-by: yar --- content/agent/technical-specifications.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/agent/technical-specifications.md b/content/agent/technical-specifications.md index 04871a2a6..d765798c0 100644 --- a/content/agent/technical-specifications.md +++ b/content/agent/technical-specifications.md @@ -14,7 +14,7 @@ and performance aligned with the NGINX core platform: {{< include "nginx-plus/supported-distributions.md" >}} To see the detailed technical specifications for NGINX Plus, refer to the official -[NGINX documentation]({{< ref "/nginx/technical-specs.md" >}}). +[NGINX Plus documentation]({{< ref "/nginx/technical-specs.md" >}}). ### Recommended hardware