Technical Specifications
Overview
The NGINX Management Suite is a comprehensive family of management plane solutions that enable you to effectively scale, secure, and monitor your applications and APIs. At its core is the NGINX Management Suite Instance Manager module, which lets you track, secure, and configure your NGINX OSS and NGINX Plus instances. Instance Manager is available as a standalone product and is automatically included when you license any other NGINX Management Suite modules.
F5 NGINX Management Suite
The guidelines in this section are applicable to the entire NGINX Management Suite gateway. Further, module-specific guidelines are highlighted in the respective sections of this document.
Support for Prior Releases
Unless otherwise specified in the release notes, NGINX typically supports the three most recent releases of Instance Manager and NGINX App Protect WAF. This means, for example, if the latest release of Instance Manager is 2.11.0, NGINX would support versions ranging from 2.8.0 to 2.11.0. The same principle applies to the other modules.
If you are using an older version of a module, you might need to upgrade to an intermediate version before upgrading to the final version you want. Make sure to follow the recommended upgrade paths mentioned in each module’s release notes for a successful upgrade process. For more detailed information and guidance on the upgrade process, you can refer to the Upgrade Guide.
Module release notes:
Supported Linux Distributions
The NGINX Management Suite gateway supports the following Linux distributions:
Distribution | Version | Architecture | Instance Manager | NGINX App Protect |
---|---|---|---|---|
Amazon Linux | 2 LTS | x86_64 | Supported | Supported |
CentOS | 7.4 and later in the 7.x family | x86_64 | Not supported in 2.17.0+ | Supported |
Debian | 11 12 |
x86_64 x86_64 |
Supported Supported on 2.13.0+ |
Supported Supported |
Oracle Linux | 7.4 and later in the 7.x family 8.0 and later in the 8.0.x family |
x86_64 x86_64 |
Supported Supported on 2.6.0+ |
Supported Supported |
RHEL | 7.4 and later in the 7.x family 8.x and later in the 8.x family 9.x and later in the 9.x family |
x86_64 x86_64 x86_64 |
Not supported in 2.17.0+ Supported Supported on 2.6.0+ |
Supported Supported Supported |
Ubuntu | 20.04 22.04 |
x86_64 x86_64 |
Supported Supported on 2.3.0+ |
Supported Supported |
Supported Deployment Environments
You can deploy the NGINX Management Suite gateway in the following environments:
- Bare Metal
- Container
- Public Cloud: AWS, Google Cloud Platform, and Microsoft Azure
- Virtual Machine
Supported NGINX Versions
NGINX Management Suite supports the following NGINX versions:
Module | Version | NGINX OSS | NGINX Plus |
---|---|---|---|
Instance Manager | 2.16.0 and later 2.7.0-2.15.1 2.0.0–2.6.0 |
1.18–1.25.1 1.18–1.25.1 1.18–1.21.6 |
R31–R32 R21–R30 R21–R27 |
Firewall Ports
The NGINX Management Suite and NGINX Agent services use the Unix domain socket by default and proxy through the gateway on port 443
.
Supported Browsers
The NGINX Management Suite web interface works best on the newest versions of these browsers:
Logging
The NGINX Management Suite stores its log files in /var/log/nms
. To prevent your system from running out of disk space due to log growth, we suggest creating a separate partition for the logs or enabling log rotation.
Instance Manager
Sizing Recommendations
The following sizing recommendations are the minimum sizing guidelines for Instance Manager. For improved performance, we strongly suggest using SSDs as your storage option.
Standard NGINX Configuration Deployments
The following sizing guidelines are for Instance Manager deployments with data plane instances that have standard configurations; that is, up to 40 upstream servers with associated location and server blocks and up to 350 associated certificates.
We recommend using solid-state drives (SSDs) for better storage performance.
# of Data Plane Instances | CPU | Memory | Network | Storage |
---|---|---|---|---|
10 | 2 vCPU | 4 GB RAM | 1 GbE NIC | 100 GB |
100 | 2 vCPU | 4 GB RAM | 1 GbE NIC | 1 TB |
1000 | 4 vCPU | 8 GB RAM | 1 GbE NIC | 3 TB |
Large NGINX Configuration Deployments
The following sizing guidelines are for Instance Manager deployments with data plane instances that have large configurations; that is, up to 300 upstream servers with associated location and server blocks.
# of Data Plane Instances | CPU | Memory | Network | Storage |
---|---|---|---|---|
50 | 4 vCPU | 8 GB RAM | 1 GbE NIC | 1 TB |
250 | 4 vCPU | 8 GB RAM | 1 GbE NIC | 2 TB |
Support for NGINX App Protect WAF
Instance Manager supports the following versions of NGINX App Protect WAF:
Instance Manager | NGINX App Protect WAF |
---|---|
2.17.0-2.17.3 | Release 4.8.0-4.10.0, 5.1.0-5.2.0 |
2.15.1-2.16.0 | Release 4.8.0-4.10.0 |
2.14.1-2.15.0 | Release 4.4.0–4.7.0 |
2.13.0-2.14.0 | Release 4.3.0–4.5.0 |
2.12.0 | Release 4.2.0–4.5.0 |
2.11.0 | Release 4.1.0–4.3.0 |
2.10.0–2.10.1 | Release 4.0.0–4.3.0 |
2.9.0–2.9.1 | Release 3.12.2–4.2.0 |
2.8.0 | Release 3.12.2–4.1.0 |
2.7.0 | Release 3.12.2–4.0.0 |
2.6.0 | Release 3.12.2 |
Security Monitoring Module
Dependencies with Instance Manager
The Security Monitoring module requires the following versions of Instance Manager to be installed on the management plane:
Security Monitoring | Instance Manager |
---|---|
1.7.1 | 2.14.1-2.17.3 |
1.7.0 | 2.14.0 |
1.6.0 | 2.12.0-2.13.0 |
1.5.0 | 2.11.0 |
1.4.0 | 2.10.0–2.10.1 |
1.3.0 | 2.9.0 |
1.2.0 | 2.8.0 |
1.1.0 | 2.7.0 |
1.0.0 | 2.6.0 |
Important:
The Security Monitoring module installation does not automatically install or upgrade Instance Manager. You’ll need to manually install Instance Manager, or upgrade it to a version supported for use with Security Monitoring.
Dependencies with NGINX App Protect WAF and NGINX Plus
The Security Monitoring module requires the following versions of NGINX App Protect WAF and NGINX Plus for the data plane:
Security Monitoring | NGINX App Protect WAF |
---|---|
1.7.1 | Release 4.7.0 - 4.11.0, 5.1.0 - 5.3.0 |
1.7.0 | Release 4.4.0 - 4.7.0 |
1.6.0 | Release 4.3.0 - 4.4.0 |
1.5.0 | Release 4.3.0 |
1.4.0 | Release 4.2.0 |
1.3.0 | Release 3.12.2 - 4.2.0 |
1.2.0 | Release 3.12.2 - 4.1.0 |
1.1.0 | Release 3.12.2 - 4.0.0 |
1.0.0 | Release 3.12.2 |
NGINX Agent (Data Plane)
Supported Distributions
The NGINX Agent can run on most environments. For the supported distributions, see the NGINX Agent Technical Specs guide.