Skip to content

Commit e77cab5

Browse files
JTorreGy82
andauthored
docs: Agent v3 tech spec (#382)hhhhhhhhhhhhhhhhhhhhhhhh
* docs: update agent v3 tech specs * docs: fix moved v2 path * Update content/agent/technical-specifications.md Co-authored-by: yar <[email protected]> * Update content/agent/technical-specifications.md Co-authored-by: yar <[email protected]> * Update content/agent/technical-specifications.md Co-authored-by: yar <[email protected]> --------- Co-authored-by: yar <[email protected]>
1 parent a18ae36 commit e77cab5

File tree

4 files changed

+33
-77
lines changed

4 files changed

+33
-77
lines changed

content/agent/technical-specifications.md

Lines changed: 10 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -5,69 +5,19 @@ weight: 700
55
docs: DOCS-000
66
---
77

8-
## Overview
8+
NGINX Agent is designed to operate efficiently on any system that meets the standard
9+
hardware requirements for running NGINX Plus itself. This ensures compatibility, stability,
10+
and performance aligned with the NGINX core platform:
911

10-
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.
12+
### Supported distributions
1113

12-
---
13-
14-
## Supported Distributions
15-
16-
The NGINX Agent is versatile and can operate across various environments. Currently, the following distributions are supported:
17-
18-
| Distribution | Supported Versions | Architectures |
19-
|------------------------------------|---------------------------------------|---------------------|
20-
| **AlmaLinux** | 8, 9 | x86_64, aarch64 |
21-
| **Alpine Linux** | 3.16, 3.17, 3.18, 3.19 | x86_64, aarch64 |
22-
| **Amazon Linux** | 2023 | x86_64, aarch64 |
23-
| **Amazon Linux 2** | LTS | x86_64, aarch64 |
24-
| **CentOS** | 7.4+ | x86_64, aarch64 |
25-
| **Debian** | 11, 12 | x86_64, aarch64 |
26-
| **Oracle Linux** | 7.4+, 8.1+, 9 | x86_64 |
27-
| **Red Hat Enterprise Linux (RHEL)**| 7.4+, 8.1+, 9.0+ | x86_64, aarch64 |
28-
| **Rocky Linux** | 8, 9 | x86_64, aarch64 |
29-
| **SUSE Linux Enterprise Server (SLES)** | 12 SP5, 15 SP2 | x86_64 |
30-
| **Ubuntu** | 20.04 LTS, 22.04 LTS | x86_64, aarch64 |
31-
32-
---
33-
34-
## Supported Deployment Environments
35-
36-
The NGINX Agent supports deployment in the following environments:
37-
38-
- **Bare Metal** machines
39-
- **Containers**
40-
- **Public Cloud** platforms, including AWS, Google Cloud Platform, and Microsoft Azure
41-
- **Virtual Machines**
42-
43-
---
44-
45-
## Supported NGINX Versions
46-
47-
The NGINX Agent is compatible with all supported releases of NGINX Open Source and NGINX Plus.
48-
49-
---
50-
51-
## Minimum System Requirements
52-
53-
Below are the recommended minimum system specifications for running the NGINX Agent:
54-
55-
| **Resource** | **Minimum Requirement** |
56-
|--------------|--------------------------|
57-
| **CPU** | 1 CPU core |
58-
| **Memory** | 1 GB RAM |
59-
| **Network** | 1 GbE NIC |
60-
| **Storage** | 20 GB |
61-
62-
---
63-
64-
## Logging
14+
{{< include "nginx-plus/supported-distributions.md" >}}
6515

66-
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.
16+
To see the detailed technical specifications for NGINX Plus, refer to the official
17+
[NGINX Plus documentation]({{< ref "/nginx/technical-specs.md" >}}).
6718

68-
To avoid system storage constraints caused by expanding log directories, it is recommended to:
6919

70-
- Set up a **dedicated partition** for `/var/log/nginx-agent`.
71-
- Enable **[log rotation](https://linux.die.net/man/8/logrotate)** to manage log file growth effectively.
20+
### Recommended hardware
7221

73-
For additional details on managing logs, refer to the [Configuration Overview]({{< relref "/agent/how-to/configuration-overview.md#logs" >}}).
22+
For recommended hardware, see the
23+
[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).

content/agent/v2/installation-upgrade/installation-unprivileged.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ The installation process involves installing NGINX Plus without root privileges
2929
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.
3030

3131
{{< note >}}
32-
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.
32+
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.
3333
{{< /note >}}
3434

3535
### Install NGINX Agent
3636

37-
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" >}}).
37+
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" >}}).
3838

3939
### Start NGINX Agent
4040

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
docs:
3+
---
4+
5+
{{<bootstrap-table "table table-striped table-bordered">}}
6+
| Distribution | Supported on R33 | Supported on R32 |
7+
|-------------------------------------|-----------------------------------------------|-----------------------------------------------|
8+
| AlmaLinux | 8 (x86_64, aarch64) <br> 9 (x86_64, aarch64) | 8 (x86_64, aarch64) <br> 9 (x86_64, aarch64) |
9+
| Alpine Linux | 3.17 (x86_64, aarch64) **(deprecated)** <br> 3.18 (x86_64, aarch64) <br> 3.19 (x86_64, aarch64) <br> 3.20 (x86_64, aarch64) **(new)** | 3.16 (x86_64, aarch64) **(deprecated)** <br> 3.17 (x86_64, aarch64) <br> 3.18 (x86_64, aarch64) <br> 3.19 (x86_64, aarch64) |
10+
| Amazon Linux | 2023 (x86_64, aarch64) | 2023 (x86_64, aarch64) |
11+
| Amazon Linux 2 | LTS (x86_64, aarch64) | LTS (x86_64, aarch64) |
12+
| CentOS | **Not supported** | 7.4+ (x86_64) **(deprecated)** |
13+
| Debian | 11 (x86_64, aarch64) <br> 12 (x86_64, aarch64) | 11 (x86_64, aarch64) <br> 12 (x86_64, aarch64) |
14+
| FreeBSD | 13 (amd64) <br> 14 (amd64) | 13 (amd64) <br> 14 (amd64) |
15+
| Oracle Linux | 8.1+ (x86_64, aarch64) <br> 9 (x86_64) | 7.4+ (x86_64) **(deprecated)** <br> 8.1+ (x86_64, aarch64) <br> 9 (x86_64) |
16+
| Red Hat Enterprise Linux (RHEL) | 8.1+ (x86_64, aarch64) <br> 9.0+ (x86_64, aarch64) | 7.4+ (x86_64) **(deprecated)** <br> 8.1+ (x86_64, aarch64) <br> 9.0+ (x86_64, aarch64) |
17+
| Rocky Linux | 8 (x86_64, aarch64) <br> 9 (x86_64, aarch64) | 8 (x86_64, aarch64) <br> 9 (x86_64, aarch64) |
18+
| SUSE Linux Enterprise Server (SLES) | 12 SP5 (x86_64) **(deprecated)** <br> 15 SP2+ (x86_64) | 12 SP5 (x86_64) <br> 15 SP2+ (x86_64) |
19+
| Ubuntu | 20.04 LTS (x86_64, aarch64) <br> 22.04 LTS (x86_64, aarch64) <br> 24.04 LTS (x86_64, aarch64) | 20.04 LTS (x86_64, aarch64) <br> 22.04 LTS (x86_64, aarch64) <br> 24.04 LTS (x86_64, aarch64 **(new)** |
20+
{{</bootstrap-table>}}

content/nginx/technical-specs.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,7 @@ NGINX Plus is available only as a binary; it is not distributed as source code.
1414

1515
## Supported Distributions {#supported-distributions}
1616

17-
{{<bootstrap-table "table table-striped table-bordered">}}
18-
| Distribution | Supported on R34 | Supported on R33 |
19-
|-------------------------------------|----------------------------------------------------|--------------------------------------------------------|
20-
| AlmaLinux | 8 (x86_64, aarch64) <br> 9 (x86_64, aarch64) | 8 (x86_64, aarch64) <br> 9 (x86_64, aarch64) |
21-
| Alpine Linux | 3.18 (x86_64, aarch64) **(deprecated)** <br> 3.19 (x86_64, aarch64) <br> 3.20 (x86_64, aarch64) <br> 3.21 (x86_64, aarch64) **(new)** | 3.17 (x86_64, aarch64) **(deprecated)** <br> 3.18 (x86_64, aarch64) <br> 3.19 (x86_64, aarch64) <br> 3.20 (x86_64, aarch64) **(new)** |
22-
| Amazon Linux | 2023 (x86_64, aarch64) | 2023 (x86_64, aarch64) |
23-
| Amazon Linux 2 | LTS (x86_64, aarch64) | LTS (x86_64, aarch64) |
24-
| Debian | 11 (x86_64, aarch64) <br> 12 (x86_64, aarch64) | 11 (x86_64, aarch64) <br> 12 (x86_64, aarch64) |
25-
| FreeBSD | 13 (amd64) <br> 14 (amd64) | 13 (amd64) <br> 14 (amd64) |
26-
| Oracle Linux | 8.1+ (x86_64, aarch64) <br> 9 (x86_64) | 8.1+ (x86_64, aarch64) <br> 9 (x86_64) |
27-
| Red Hat Enterprise Linux (RHEL) | 8.1+ (x86_64, aarch64) <br> 9.0+ (x86_64, aarch64) | 8.1+ (x86_64, aarch64) <br> 9.0+ (x86_64, aarch64) |
28-
| Rocky Linux | 8 (x86_64, aarch64) <br> 9 (x86_64, aarch64) | 8 (x86_64, aarch64) <br> 9 (x86_64, aarch64) |
29-
| SUSE Linux Enterprise Server (SLES) | 15 SP2+ (x86_64) | 12 SP5 (x86_64) **(deprecated)** <br> 15 SP2+ (x86_64) |
30-
| Ubuntu | 20.04 LTS (x86_64, aarch64) **(deprecated)** <br> 22.04 LTS (x86_64, aarch64) <br> 24.04 LTS (x86_64, aarch64) | 20.04 LTS (x86_64, aarch64) <br> 22.04 LTS (x86_64, aarch64) <br> 24.04 LTS (x86_64, aarch64) |
31-
{{</bootstrap-table>}}
17+
{{< include "nginx-plus/supported-distributions.md" >}}
3218

3319
---
3420

0 commit comments

Comments
 (0)