Technical Specifications
This document lists the requirements for NGINX Instance Manager, including supported platforms, hardware specs, sizing guidelines, supported browsers, and more.
This documentation applies to NGINX Instance Manager 2.0.0 and later.
Overview
NGINX Instance Manager is available in binary form only; it is not available in source form. To inquire about additional platforms and modules, contact NGINX Sales.
Supported Distributions
NGINX Instance Manager
- NGINX Instance Manager supports the following distributions:
Table: Supported distributions for NGINX Instance Manager
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 | x86_64 |
NGINX Agent
- The NGINX Agent can run on most environments. For the supported distributions, see the NGINX Technical Specs guide.
Supported Deployment Environments
NGINX Instance Manager and the NGINX Agent work with the following environments:
- Bare Metal
- Container
- Public Cloud: AWS, Google Cloud Platform, and Microsoft Azure
- Virtual Machine
System Recommendations
The following sizing recommendations are the minimum sizing guidelines for NGINX Instance Manager. We highly recommend using SSD as your storage for better performance.
Standard NGINX Configuration Deployments
The following sizing guidelines are for NGINX Instance Manager deployments with data plane instances that have standard configurations; that is, up to 40 upstream servers with associated location and server blocks.
Table: Server sizing for standard configs
# 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 NGINX Instance Manager deployments with data plane instances that have large configurations; that is, up to 300 upstream servers with associated location and server blocks.
Table: Server sizing for large configs
# 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 |
NGINX Agent
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
NGINX Instance Manager Server 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 or and/or enabling log rotation.
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.
Supported NGINX Versions
NGINX Instance Manager (Control Plane)
The NGINX Instance Manager server uses NGINX as a frontend proxy and supports the following versions of NGINX OSS and NGINX Plus:
Table: NGINX Instance Manager – Supported NGINX Versions
NGINX Model | Supported Versions |
---|---|
NGINX OSS | 1.18 and later |
NGINX Plus | R21 and later |
NGINX Agent (Data Plane)
The NGINX Agent works with all versions of NGINX OSS and NGINX Plus.
Supported Browsers
NGINX Instance Manager works best on the newest versions of these browsers:
Firewall Ports
The NGINX Instance Manager and NGINX Agent services use the Unix domain socket by default and proxy through the gateway on port 443.