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.

Manage API Infrastructure

Learn how to use F5 NGINX Management Suite API Connectivity Manager to manage your API infrastructure.

Overview

API Connectivity Manager lets you manage your API infrastructure by using a set of hierarchical resources. The top-level resource, called a Workspace, provides a logical grouping for resources called Environments. Environments contain Clusters that allocate NGINX instances for use as API Gateways and Developer Portals.

You can use Workspaces to create isolated work areas for business units or teams. You can use Environments to allocate infrastructure resources for use within a team’s Workspace.

This guide provides instructions for using API Connectivity Manager Workspaces and Environments to manage your API infrastructure.

Before You Begin

Complete the following prerequisites before proceeding with this guide:

• API Connectivity Manager is installed, running, and licensed.
• You have SSH access to the host where API Connectivity Manager is running and can use the sudo command.
• You have installed a supported version of F5 NGINX Plus on each host that you want to add to a Cluster.
• You know the IP address or FQDN for each host that you want to add to a cluster.
• You have SSH access to each of the hosts that you want to allocate to a cluster and can use the sudo command.
• You have installed the njs module on each host that you want to add to the cluster.

How to Access the User Interface

This guide provides instructions for completing tasks using the API Connectivity Manager user interface (UI).

To access the UI, go to the FQDN of your NGINX Management Suite host and log in. On the Launchpad menu, select “API Connectivity Manager.”

Create a Workspace

• UI
• API

{
    "name":  "{{infraWorkspaceName}}",
    "metadata": {
        "description": "Petstore Team Workspace"
    },
    "contactDetails": {
        "adminEmail": "admin@example.com",
        "adminName": "I.M. Admin",
        "adminPhone": "555 123 1234"
    }
}

Add an Environment

• UI
• API

{
    "name": "{{environmentname}}",
    "proxies": [
        {
            "proxyClusterName": "{{proxyClusterName}}",
            "hostnames": [
                "{{environmentHostname}}"
            ]
        }
    ]
}

Onboard an NGINX Instance

Install the NGINX Agent on each host to register the instance with API Connectivity Manager as part of the cluster.

Take the steps below to add an NGINX instance to an API Gateway.

1. Use SSH to log in to the host machine.
2. Run the cURL or wget install command that was displayed in the Environment Created confirmation drawer.
3. When the installation is complete, the instance will appear in the Instances list for the cluster in the API Connectivity Manager user interface.
4. After running the cURL command you can check the environment job status on the environments page

   

Environment Statuses

Lost your install command?

Don’t worry! You can take the steps below to recover it:

1. In the API Connectivity Manager user interface, go to Infrastructure > Environments > <your environment>.
2. Click anywhere in the row of the Cluster that you want to add an instance to.
3. The Onboarding Commands will be shown in the cluster details drawer.