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

The NGINX Management Suite is a platform that consists of the following modules:

  • Instance Manager
  • (optional) API Connectivity Manager

The NGINX Management Suite includes Instance Manager by default. This module will be installed for you if you install any of the optional modules.

NGINX Management Suite

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

Supported Distributions

The NGINX Management Suite modules support the following distributions:

Distribution Version Platform
Amazon Linux 2 LTS x86_64
CentOS 7.4+ x86_64
Debian 10, 11 x86_64
Oracle Linux 7.4+ x86_64
RHEL 7.4+, 8 x86_64
Ubuntu 18.04, 20.04, 22.04 x86_64

Supported Deployment Environments

You can deploy the NGINX Management Suite modules 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 and individual modules support 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.


NGINX Agent

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:

Table: NGINX Agent sizing recommendations

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.


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.

# 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

API Connectivity Manager

Data Plane and Developer Portal

The API Connectivity Manager data plane and Developer Portal hosts require NGINX Plus R21 or later.

You can run the Developer Portal on one or more hosts. The Developer Portal requires a separate, dedicated host. Do not install the Developer Portal on a host that is already running the management or data planes.