NGINX Documentation

Tech Specs for NGINX Controller and Controller Agent

This guide lists the technical recommendations for NGINX Controller and the Controller Agent. Review this guide before installing or updating NGINX Controller or the Controller Agent.

NGINX Controller Technical Specifications

Supported Distributions

NGINX Controller supports the following distributions and architectures. Unless stated otherwise, these distributions work with all versions of NGINX Controller.

  • CentOS 7 (x86_64)
  • Debian 8 (x86_64) – Works only with NGINX Controller 2.7 and earlier
  • Debian 9 (x86_64)
  • Red Hat Enterprise Linux 7 (x86_64)
  • Ubuntu 16.04 LTS (x86_64
  • Ubuntu 18.04 LTS x86_64)

Supported Deployment Environments

You can deploy NGINX Controller into the following environments:

  • Bare metal
  • Public cloud: Amazon Web Services, Google Cloud Platform, Microsoft Azure
  • Virtual Machine

Hardware Specifications

NGINX Controller requires the following minimum hardware specifications:

  • RAM: 8 GB RAM
  • CPU: 8-Core CPU @ 2.40 GHz or similar
  • Disk space: 80 GB free disk space

Supported NGINX Plus Versions

NGINX Controller v3 supports the following NGINX Plus versions:

  • NGINX Plus R20
  • NGINX Plus R19

NGINX Controller v2 supports the following NGINX Plus versions:

  • NGINX Plus R19
  • NGINX Plus R18
  • NGINX Plus R17
  • NGINX Plus R16
  • NGINX Plus R15

Using Local or External Storage for the Analytics Database

When installing NGINX Controller, you can choose the type of volume that’s used to store the analytics database. The types of volumes that are supported are:

Local Storage

When using local storage for the analytics database, we recommend the following specs:

  • 100 IOPS
  • 130 GB free disk space (that’s the standard recommendation of 80 GB + 50 GB for the local analytics database)
Tip: To conserve IO and/or disk space, you can use a separate disk for the local storage directory /opt/nginx-controller/clickhouse_data.

NFS

To use NFS for external storage for the analytics database, consider the following:

  • Make certain that the NFS version used by the server is supported by the client system where you’re installing NGINX Controller.
  • If you’re using NFS v4 file locking or Network Lock Manager (NLM) on the NFS server, make sure that the client system that’s running your NGINX Controller has access to the mount point.
  • The owner of the mount point must be set to 101:101, or the root_sqash option must be disabled on the NFS server.

AWS EBS

You can use Amazon Elastic Block Store (EBS) for the analytics database if NGINX Controller is installed on AWS and the EBS volume is in the same availability zone as the EC2 instance. See the AWS EBS User Guide for instructions on how to create and configure EBS volumes.

To use AWS EBS for the analytics database, use the following configuration:

EC2 Tag:
Key: kubernetes.io/cluster/NGINX-CONTROLLER
Value: owned
IAM Role:

  {
      "Version": "2012-10-17",
      "Statement": [
          {
              "Effect": "Allow",
              "Action": [
                  "ec2:AttachVolume",
                  "ec2:DetachVolume",
                  "ec2:DescribeInstances",
                  "ec2:ModifyVolume",
                  "ec2:DescribeVolumes"
              ],
              "Resource": [
                  "*"
              ]
          }
      ]
  }

Firewall / IP Settings

  • DB: Port 5432 TCP – incoming to DB from NGINX Controller host
  • NGINX Controller: Port 80 TCP – incoming from NGINX Plus instances
  • NGINX Controller: Port 443 TCP – incoming from where you are accessing from a browser, for example, an internal network
  • NGINX Controller: Port 8443 TCP – incoming from NGINX Plus instances

NGINX Controller 2.8 and later: If you have a firewall running on the NGINX Controller host, enable NAT (masquerade) and open the following ports. Note: These ports are used for internal traffic only and don’t need to be open to the outside.

For more information about these ports, see the Kubernetes guide Installing kubeadm.

  • NGINX Controller: 6443 TCP: incoming requests to the Kubernetes master node; used for the Kubernetes API server
  • NGINX Controller: 10250 TCP: incoming requests to the Kubernetes worker node; used for the Kubelet API

Controller Agent Technical Specifications

  • NGINX Controller, using the NGINX Controller Agent, can monitor and manage up to 100 NGINX Plus instances.
  • The Controller Agent works with Python 2.6 and 2.7. Python 3 is not supported.

Supported Distributions

The Controller Agent supports the following distributions and architectures:

  • Amazon Linux 2 (x86_64)
  • Amazon Linux 2017.09 (x86_64)
  • Debian 8 (i386, amd64)
  • Debian 9 (i386, amd64)
  • RHEL/CentOS 6 (i386, amd64)
  • RHEL/CentOS 7 (x86_64)
  • Ubuntu 16.04 (i386, amd64)
  • Ubuntu 18.04 (amd64)


Supported Distributions for App-Centric Metrics

NGINX Controller v3.1.0 and later use an Analytics, Visibility, and Reporting daemon (AVRD) to aggregate and report app-centric metrics, which you can use to track and check the health of your apps. To learn more about these metrics, see the “NGINX Metrics Catalog” topic in your NGINX Controller documentation, located at: https://<your-controller-FQDN>/docs/analytics/metrics/reference/catalog/.

The following distributions support app-centric metrics:

  • Amazon Linux 2 (x86_64)
  • Amazon Linux 2017.09 (x86_64)
  • Debian 9 (amd64)
  • CentOS 7 (x86_64)
  • Ubuntu 16.04 (amd64)
  • Ubuntu 18.04 (amd64)

Open-Source Licenses

The list of open-source packages and their licenses used by NGINX Controller can be found in the downloaded file that is part of the NGINX Controller package. On your NGINX Controller host, see controller-installer/files/license-controller.pdf.

In addition, see the AskF5 KB article Third-party software for NGINX Controller controller-datacollection-components for third-party software packages that may be used by or distributed with controller-datacollection-components. This information is not included in the license-controller.pdf that’s mentioned above.