End of Sale Notice:

F5 NGINX is announcing the End of Sale (EoS) for NGINX Management Suite API Connectivity Manager Module, effective January 1, 2024.

F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing API Connectivity Manager Module customers can continue to use the product past the EoS date. License renewals are not available after September 30, 2024.

See our End of Sale announcement for more details.

Offline Installation Guide

Install or Upgrade API Connectivity Manager

End of Sale Notice:

F5 NGINX is announcing the End of Sale (EoS) for NGINX Instance Manager API Connectivity Manager Module, effective January 1, 2024.

F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing API Connectivity Manager Module customers can continue to use the product past the EoS date. License renewals are not available after September 30, 2024.

See our End of Sale announcement for more details.

Dependencies with Instance Manager

API Connectivity Manager depends on the platform capabilities of Instance Manager. The following table lists the minimum versions of Instance Manager required for API Connectivity Manager:

API Connectivity Manager Instance Manager Dependency
1.9.0 - 1.9.3 2.13.0 and later
1.8.0 2.12.0 and later
1.6.0 - 1.7.0 2.10.0 and later
1.5.0 2.9.0 and later
1.4.0 - 1.4.1 2.7.0 and later
1.3.0 - 1.3.1 2.6.0 and later
1.1.0 - 1.2.0 2.4.0 and later
1.0.0 2.3.0 and later

To ensure API Connectivity Manager’s new features work correctly, you may need to install or upgrade Instance Manager to the minimum version specified. If Instance Manager is not installed, API Connectivity Manager will install the latest version. If the installed version is below the minimum required version, API Connectivity Manager will upgrade Instance Manager to the latest version. Otherwise, API Connectivity Manager will leave Instance Manager unchanged.

Install API Connectivity Manager

Important:

API Connectivity Manager requires Instance Manager to be installed first.

Before you begin:

  1. Review the Dependencies with Instance Manager table above.
  2. Install a compatible version of Instance Manager.

 

To install API Connectivity Manager, take the following steps:

  1. Log in to the MyF5 Customer Portal and download the API Connectivity Manager package files.

  2. Install the API Connectivity Manager package:

    sudo rpm -ivh --nosignature /home/<user>/nms-api-connectivity-manager_<version>.x86_64.rpm

To install API Connectivity Manager, take the following steps:

  1. Log in to the MyF5 Customer Portal and download the API Connectivity Manager package files.

  2. Install the API Connectivity Manager package:

    sudo apt-get install -f /home/<user>/nms-api-connectivity-manager_<version>_amd64.deb

  1. Enable and start the API Connectivity Manager service:

    sudo systemctl enable nms-acm --now

    F5 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 necessary depending on your installation configuration.

  • 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 Instance Manager won’t be able to connect to ClickHouse.

  • 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 Instance Manager won’t be able to connect to Vault.

  • 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 Instance Manager.

See these topics below for instructions on how to access the web interface and add your license:

Upgrade API Connectivity Manager

To upgrade API Connectivity Manager to a newer version, take the following steps:

  1. Log in to the MyF5 Customer Portal and download the API Connectivity Manager package file.

  2. Upgrade the API Connectivity Manager package:

    sudo rpm -Uvh --nosignature /home/user/nms-api-connectivity-manager_<version>.x86_64.rpm

To upgrade API Connectivity Manager to a newer version, take the following steps:

  1. Log in to the MyF5 Customer Portal and download the API Connectivity Manager package file.

  2. Upgrade the API Connectivity Manager package:

    sudo apt-get -y install -f /home/user/nms-api-connectivity-manager_<version>_amd64.deb

  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 API Connectivity Manager service:

     sudo systemctl restart nms-acm

  3. Restart the NGINX web server:

    sudo systemctl restart nginx

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

Set Up the Data Plane

The API Connectivity Manager data plane requires NGINX Plus R24 or later and njs..

  1. Log in to MyF5 and download your nginx-repo.crt and nginx-repo.key files.

  2. Copy the nginx-repo.crt and nginx-repo.key files to the /etc/ssl/nginx/ directory:

    sudo cp nginx-repo.crt /etc/ssl/nginx/
sudo cp nginx-repo.key /etc/ssl/nginx/

  3. Select the following link to download the fetch-external-acm-dataplane-dependencies.sh script. This script downloads the necessary NGINX Plus and njs packages to a tar.gz archive.

    Download fetch-external-acm-dataplane-dependencies.sh script

  4. To download the NGINX Plus and njs dependencies, run the fetch-external-acm-dataplane-dependencies.sh script. As parameters, specify your Linux distribution and the location of your nginx-repo.crt and nginx-repo.key files.

    sudo bash fetch-external-acm-dataplane-dependencies.sh <linux distribution> /etc/ssl/nginx/nginx-repo.crt /etc/ssl/nginx/nginx-repo.key

    Supported Linux distributions:

    • ubuntu18.04
    • ubuntu20.04
    • debian10
    • debian11
    • centos7
    • centos8
    • rhel7
    • rhel8
    • amzn2

    For example, to download external dependencies for Ubuntu 20.04:

    sudo bash fetch-external-acm-dataplane-dependencies.sh ubuntu20.04 /etc/ssl/nginx/nginx-repo.crt /etc/ssl/nginx/nginx-repo.key

    In this example, the script creates an archive called acm-dataplane-dependencies-ubuntu20.04.tar.gz with the external dependencies.

  5. After you copy and extract the bundle onto your target machine, take the following steps to install the packages:

    Note:
    The bundled NGINX Plus package may conflict with installed versions of NGINX Plus. Delete the package from the bundle if you want to keep the existing version.

    tar -kzxvf acm-dataplane-dependencies-<linux-distribution>.tar.gz
sudo rpm -ivh *.rpm


    tar -kzxvf acm-dataplane-dependencies-<linux-distribution>.tar.gz
sudo dpkg -i ./*.deb