Install or Upgrade Instance Manager

Follow the steps in this guide to install or upgrade NGINX Management Suite Instance Manager.


Before You Begin

Security Considerations

To ensure that your NGINX Management Suite deployment remains secure, follow the recommendations in this section:

  • Install NGINX Management Suite and its modules on a dedicated machine (bare metal, container, cloud, or VM).
  • Make sure that no other services are running on the same machine.
  • Make sure that the machine is not accessible from the Internet.
  • Make sure that the machine is behind a firewall.

Installation Prerequisites

Important:
Before you can install this module, you need to have NGINX and ClickHouse installed on your system. Additionally, you will need to add the NGINX Management Suite repository. The Prerequisites topic has detailed instructions on how to fulfill these requirements.

Install Instance Manager

  1. To install the latest version of Instance Manager, run the following command:

    sudo yum install -y nms-instance-manager
    

    IMPORTANT! The Instance Manager’s administrator username (default is admin) and generated password are displayed in the terminal during installation. You should make a note of the password and store it securely.

  1. To install the latest version of Instance Manager, run the following commands:

    sudo apt-get update
    sudo apt-get install -y nms-instance-manager
    

    IMPORTANT! The Instance Manager’s administrator username (default is admin) and generated password are displayed in the terminal during installation. You should make a note of the password and store it securely.

  1. Enable and start the NGINX Management Suite platform services:

    sudo systemctl enable nms nms-core nms-dpm nms-ingestion nms-integrations --now
    

    NGINX Management Suite components started this way run by default as the non-root nms user inside the nms group, both of which are created during installation.

  2. Restart the NGINX web server:

    sudo systemctl restart nginx
    

Post-Installation Steps

The following steps may be optional, depending on your installation configuration.

  1. (Optional) If you used a custom address, username, or password or enabled TLS when installing ClickHouse, follow the steps in the Configure ClickHouse guide to update the /etc/nms/nms.conf file. If you don’t do so, NGINX Management Suite won’t be able to connect to ClickHouse.

  2. (Optional) If you use Vault, follow the steps in the Configure Vault guide to update the /etc/nms/nms.conf file. If you don’t do so, NGINX Management Suite won’t be able to connect to Vault.

  3. (Optional) If you use SELinux, follow the steps in the Configure SELinux guide to restore SELinux contexts (restorecon) for the files and directories related to NGINX Management suite.

Accessing the Web Interface

To access the NGINX Management Suite web interface, go to https://<NMS_FQDN> for your NGINX Management Suite host and log in.

The default administrator username is admin, and the generated password was displayed in the terminal during installation.

Add License

A valid license is required in order to use all of the features in Instance Manager.

Download License

To download a license for NGINX Management Suite:

  1. Go to the MyF5 Customer Portal and sign in.
  2. On the top menu, select My Products & Plans > Trials.
  3. In the My Trials list, select your your NGINX Management Suite trial.
  4. Select the Licenses and Certificates link.
  5. On the Getting started panel, select Download License. The license .lic file is saved to your system.

Apply License

To upload and apply a license for NGINX Management Suite:

  1. Go to the FQDN for your NGINX Management Suite host in a web browser and log in.
  2. Select the Settings gear icon.
  3. On the Settings menu, select Licenses.
  4. Select Upload License.
  5. Locate the .lic file that you downloaded to your system, then select Upload.

Upgrade Instance Manager

  1. To upgrade to the latest version of the Instance Manger, run the following command:

    sudo yum update -y nms-instance-manager
    

  1. To upgrade to the latest version of the Instance Manager, run the following command:

    sudo apt-get update
    sudo apt-get install -y --only-upgrade nms-instance-manager
    
  1. Restart the NGINX Management Suite platform services:

    sudo systemctl restart nms
    

    NGINX Management Suite components started this way run by default as the non-root nms user inside the nms group, both of which are created during installation.

  2. Restart the NGINX web server:

    sudo systemctl restart nginx
    
  3. (Optional) If you use SELinux, follow the steps in the Configure SELinux guide to restore the default SELinux labels (restorecon) for the files and directories related to NGINX Management suite.


What’s Next

Set Up the Data Plane

Complete the following steps for each data plane instance you want to manage using Instance Manager:

Set up NGINX App Protect WAF

Install Other NGINX Management Suite Modules