Technical Specifications

This document describes the requirements for the NGINX Management Suite and NGINX Agent, including supported platforms, hardware specs, sizing guidelines, supported browsers, and more.

Overview

NGINX Management Suite is a family of management plane solutions that enable governance of the NGINX data plane to easily scale, secure, and monitor applications and APIs.

At the core of the NGINX Management Suite is Instance Manager. This core module lets you track, secure, and configure your NGINX OSS and NGINX Plus instances.

Instance Manager is available as a standalone module. Additionally, because Instance Manager is at the heart of NGINX Management Suite, it’s automatically installed whenever you install other modules, such as API Connectivity Manager.


NGINX Management Suite

The guidelines in this section apply to the NGINX Management Suite gateway overall. Module-specific guidelines are called out in individual sections elsewhere in this document.

Supported Distributions

The NGINX Management Suite gateway supports the following Linux distributions:

Distribution Version Platform NIM ACM
Amazon Linux 2 LTS x86_64 2.0 and later 1.0 and later
CentOS 7.4 and later in the 7.x family x86_64 2.0 and later 1.0 and later
Debian 10
11
x86_64
x86_64
2.0 and later
2.0 and later
1.0 and later
1.0 and later
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
2.0 and later
2.6 and later
1.0 and later
Not 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
2.0 and later
2.0 and later
2.6 and later
1.0 and later
1.0 and later
Not supported
Ubuntu 18.04
20.04
22.04
x86_64
x86_64
x86_64
2.0 and later
2.0 and later
2.3 and later
1.0 and later
1.0 and later
1.0 and later

Note:
If you’re installing the API Connectivity Manager module, make sure to review the supported distributions for the Developer Portal host. That list varies slightly from this one.

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

The NGINX Management Suite gateway supports the following NGINX versions:

NGINX Model Supported Versions
NGINX OSS 1.18 and later
NGINX Plus R21 and later

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 uses the system logging process to write log files, usually to /var/log/nms. To prevent your system from running out of space due to log growth, we recommend using a separate partition for the logs and/or enabling log rotation.


Instance Manager

Sizing Recommendations

The following sizing recommendations are the minimum sizing guidelines for Instance Manager. We highly recommend using SSD as your storage for better performance.

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.

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.6.0 and later Release version 3.12.2

API Connectivity Manager

Dependencies with Instance Manager

API Connectivity Manager (ACM) depends on the platform capabilities of Instance Manager. The following table lists the minimum versions of Instance Manager required for ACM:

API Connectivity Manager Instance Manager
ACM 1.1 and later NIM 2.4 and later
ACM 1.0 NIM 2.3 and later

For new features in ACM to work correctly, ACM may need to install or upgrade Instance Manager to a specific minimum version, as follows:

  • If Instance Manager isn’t installed, ACM will install the latest version of Instance Manager for you.
  • If the installed version of Instance Manager is below the minimum version required for ACM, ACM will upgrade Instance Manager to the latest version.
  • If Instance Manager is at or above the minimum required version for ACM, ACM will leave Instance Manager unchanged.
Important:
If you’re installing ACM in an offline environment and the minimum required version of Instance Manager is not installed, the ACM installer will exit. You’ll need to install Instance Manager manually before installing ACM.

Data Plane and Developer Portal

Supported NGINX Plus Versions

The API Connectivity Manager data plane and Developer Portal work with the following NGINX Plus versions:

Host Supported Versions
ACM data plane R24 and later
ACM Developer Portal R24 and later

Developer Portal Supported Distributions

The Developer Portal supports the following Linux distributions:

Distribution Version Platform ACM Developer Portal
Amazon Linux 2 LTS x86_64 1.0 and later
CentOS 7.4 and later in the 7.x family x86_64 1.0 and later
Debian 10
11
x86_64
x86_64
1.0 and later
1.0 and later
Oracle Linux 7.4 and later in the 7.x family x86_64 1.0 and later
RHEL 7.4 and later in the 7.x family
8.x
x86_64
x86_64
1.0 and later
1.0 and later
Ubuntu 18.04
20.04
x86_64
x86_64
1.0 and later
1.0 and later

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.0.0 2.6.0 and later
Important:
The Security module will not install or upgrade Instance Manager automatically. You’ll need to manually install or upgrade Instance Manager to a supported version.

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 NGINX Plus
1.0.0 Release version 3.12.2 R27

NGINX Agent (Data Plane)

Supported Distributions

The NGINX Agent can run on most environments. For the supported distributions, see the NGINX Technical Specs guide.

Supported Deployment Environments

You can deploy the NGINX Agent in the following environments:

  • Bare Metal
  • Container
  • Public Cloud: AWS, Google Cloud Platform, and Microsoft Azure
  • Virtual Machine

Supported NGINX Versions

The NGINX Agent works with all versions of NGINX OSS and NGINX Plus.

Sizing Recommendations

The following table lists the minimum sizing recommendations for the NGINX Agent:

CPU Memory Network Storage
1 CPU core 1 GB RAM 1 GbE NIC 20 GB

Logging

The NGINX Agent uses the log files and formats to collect metrics. Expanding the log formats and instance counts will also increase the size of the log files on the NGINX Agent. Adding a separate partition for /var/log/nginx-agent is always a good idea. Without log rotation or a separated partition, a log directory could cause your system to run out of space.