2.5 Deployment Requirements of Secure API Manager

Secure API Manager provides a single image that allows you to choose which components to deploy on an appliance. You can deploy one, two, three, or all four components on one appliance depending on your environment. Ensure that you have read and understand how you should deploy Secure API Manager in your environment. For more information, see Understanding Deployment Scenarios.

The following table contains the minimum requirements required to deploy a single Secure API Manager appliance. Whether you deploy one or more components on an appliance, the requirements do not change.

NOTE:Deploying all of the components on one appliance is supported only for testing purposes. This configuration is not supported in a production environment.

Ensure that you meet these minimum requirements before deploying the product.

Table 2-2 Secure API Manager Appliance Requirements

Component

Requirements

Virtual system

VMware ESX 6.5 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.

Hard disk space

60 GB (per appliance)

Memory

12 GB of RAM (per appliance)

Processors

4 (per appliance)

Browsers

  • Google Chrome latest version

  • Microsoft Edge latest version

  • Microsoft Internet Explorer 11 with latest patches

  • 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 components. The DNS name of each appliance 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 components cannot communicate with each other and 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 Ports for Secure API Manager.

Trusted root certificate or self-signed certificate

The Secure API Manager components communicate securely over SSL. You must have a trusted root certificate or use a self-signed certificate to have the Deployment Manager work.

License

The license is required to receive online updates. Obtain the license from the Customer Center. You add the license to each appliance after you complete the installation. For more information, see Performing an Online Update in the NetIQ Secure API Manager 1.1 Administration Guide.

NetIQ Access Manager 4.5 or later

Secure API Manager is an add-on product for Access Manager 4.5 or later. You must have Access Manager deployed and running before deploying Secure API Manager. For more information, see Section 3.0, Integrating Secure API Manager with Access Manager.

Network File System (NFS) v3

If you cluster the component for high availability and load balancing, you must have a Network File System (NFS) server deployed and running in your IT environment that Secure API Manager uses. For more information, see Using High Availability and Load Balancing with Secure API Manager.