2.4 Meeting the Deployment Requirements of Secure API Manager

Secure API Manager provides an appliance or Docker container that you deploy that contains the API Gateway and the integrated components for Access Manager. The following table contains the minimum requirements to deploy Secure API Manager.

Table 2-2 Secure API Manager Requirements

Component

Requirements

Appliance

VMware ESX 6.7 or later

NOTE:Your VMware license must be Enterprise or Enterprise Plus if you want to use remote serial connections. For more information, see the VMware documentation.

Docker

Hard disk space

60 GB (per node if clustering)

Memory

12 GB of RAM (per node if clustering)

Processors

4 (per node if clustering)

Browsers

  • Google Chrome latest version

  • Microsoft latest version

  • Mozilla Firefox latest version

Publicly Resolvable DNS Name

Each DNS name of the appliance must be publicly resolvable. Secure API Manager uses Docker containers to create the product. The DNS name of each node must be publicly resolvable to allow the Docker containers to access the local /etc/hosts file of the appliance. If the DNS name is not publicly resolvable the product does not work.

IP Ports

Ensure that the default ports for Secure API Manager are open in your firewall. For more information, see Understanding the Ports for Secure API Manager.

Trusted root certificate or self-signed certificate

Secure API Manager communicates securely with Access Manager by default. To enable this communication, you must have a trusted root certificate or a self-signed certificate that you create or import into the Access Manager certificate management service. For more information, see Create or Import a Certificate for Secure API Manager in the NetIQ Secure API Manager 2.2 Administration Guide.

License and Activation Key

The license is required to configure the product. The activation key is required to perform online updates. Obtain the license and the activation key from the Software Licenses and Downloads portal. You add the license through the Access Manager Administration Console. For more information, see Install the Secure API Manager License and Activation Key in the NetIQ Secure API Manager 2.2 Administration Guide.

NetIQ Access Manager 5.0 SP4 later

Secure API Manager is an add-on product for Access Manager 5.0 SP4 or later. You must have Access Manager deployed and running before deploying Secure API Manager. You configure Secure API Manager through the Access Manager Administration Console.