Technical Specifications

NGINX Instance Manager Technical Specifications

NGINX Instance Manager Technical Specifications

NGINX Instance Manager is available in binary form only; it is not available in source form. Please inquire for additional platforms and modules.

Supported Distributions

The Server and Agent can run on most environments. Supported distributions are listed below and should follow NGINX Plus supported distributions excluding non 64bit.

Distribution Version Platform rpm deb binary
RHEL/CentOS 6,7,8 x86_64 X X
Debian 9,10 x86_64 X X
Ubuntu 16.04,18.04,20.04,20.10 x86_64 X X
SLES 12,15 x86_64 X X
Alpine 3.10,3.11,3.12 x86_64 X
Amazon Linux 2018.03+ x86_64 X X
Amazon Linux 2 LTS x86_64 X X
FreeBSD 11.4+,12.1+ amd64 X
Oracle Linux 7.4+ x86_64 X
Fedora 30,31,32,33 x86_64 X X

Supported Deployment Environments

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

Recommended Hardware

Minimum Server Sizing

  • 1 CPU Core
  • 1 GB RAM
  • 1GbE NIC
  • 20GB HDD

Recommended Server Sizing for up to 250 instances:

  • 2 CPU Cores
  • 4 GB RAM
  • 1GbE NIC
  • 80GB HDD (use 20GB or less for root and 60GB for /var/nginx-manager, /var/log/nginx-manager)

Recommended Server Sizing for up to 1000 instances:

  • 4 CPU Cores
  • 8 GB RAM
  • 1GbE NIC
  • 220 GB HDD (use 20GB or less for root and 200GB for /var/nginx-manager, /var/log/nginx-manager)

The sizing is based on a number of factors and should be adjusted accordingly. The above suggestions are guidelines only. You can support more instances with high core, memory, and disk IOP/space.

Storage Sizing

NGINX Instance Manager is distributed as a package sized under 25MB but doesn’t include the logs and database files that may grow on a system. To handle this, we recommend splitting up the partitions on your system and minimally putting the three directories on one partition or placing them in 3 partitions separately.

Directory Usage Growth IOPS
/var/nginx-manager VictoriaMetrics Database and Cache for UI and Scan Very High Very High
/var/logs/nginx-manager Log files High High

Minimally you should allocate 20GB across the directories but especially to the /var/nginx-manager which will consume the most space and IOPS.

The Log directory will growth based on the number of instances you collect, IOPS, and Growth will scale accordingly.

Logging

NGINX Instance Manager Server uses the system logging to place log files, usualling in /var/log/nginx-manager. Using a seperate partition and/or log rotation can help prevent your system running out of space due to log growth.

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 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.

NGINX Versions

NGINX Agents should run on almost every version we have but we do restrict support to the following. If you have a good reason to run this on an earlier version please let support know and we can look to include it. Just because a version is not listed does not mean NGINX Instance Manager won’t run, it means we just don’t test against it and therefore can’t claim to support it.

If you run a custom build (you compiled it yourself), please check with support about concerns over support. The table below assumes distributed binaries for version but we can work with you on exceptions if necessary. Ideally ask about this before purchasing.

NGINX Plus Versions:

  • R21
  • R22
  • R23

NGINX Open Source Versions:

  • 1.16
  • 1.18
  • 1.19

NGINX Directives and Configurations

NGINX Instance Manager supports every directive and every configuration that NGINX Open Source and Plus can run. If NGINX can run it, we can handle it. Due to the complexity and number of options, we use subsets of configurations and options to test. If you find a configuration or directive that isn’t properly working with the agent, contact support and let us know and we will prioritize it and/or list it here with great embarrassment.

Number of known configuration exceptions: 0

  • this list item intentionally left blank

Supported Browsers

NGINX Instance Manager works best on the newest and the last prior version of these browsers

Firewall Ports

Configure the NGINX Instance Manager Server with the following firewall settings.

Port src dest Description
10000/tcp Server Agent gRPC communication (change to your proxy port if using NGINX Plus)
11000/tcp Server any GUI and API port, open externally to users restrict to known range (change to your proxy port if using NGINX Plus)
10000/tcp Agent Server gRPC communication
8080/tcp Agent localhost NGINX Plus api or NGINX OSS Stub Status Page (change to your published port, you do not need to expose this externally to the server)