Configuring IBM API Connect® to use a DataPower Tenant

You can configure IBM® API Connect to work with a tenant on a physical Type 8436 DataPower Gateway.

Before you begin

Prepare the Type 8436 DataPower Gateway to support tenants.

  • Ensure that the DataPower Gateway is running firmware version 7.6.0.0 or later.
  • Ensure that the Application Optimization and Tenant modules are activated on the DataPower Gateway.
  • Create a tenant and install its initial firmware. For instructions, see Creating a tenant and installing its firmware.

For additional information about tenants on a DataPower Gateway, see Tenants.

About this task

A Type 8436 DataPower Gateway with the Tenant module can host an independent gateway instance known as a tenant. The following procedure configures IBM API Connect to use a DataPower tenant.

Procedure

  1. Define the memory, CPU, and management connections to the DataPower tenant.
    From the default domain of the landlord, you can modify the connection details for the tenant. Each tenant and the landlord have different management interfaces and a different quota enforcement server.
    • When you define the addresses for tenant management interfaces, you must use an explicit IP address, not a host alias, to isolate tenant management traffic from the landlord management traffic. Tenant services that use the IP address values of 0.0.0.0 or :: can cause port contention on the landlord.
    • When you define listening ports for tenant management interfaces, comply to the following guidance.
      • Use a value that is greater than 1024.
      • Ensure that they are unique across the tenants and the landlord.
    The following configuration example is for only illustrative purposes. Define the setting based on your environment and processing needs.
    1. In the CPUs field, enter 16 as the number of CPU threads to allocate to the tenant.
    2. In the Memory field, enter 32 as the memory in GiB to allocate to the tenant.
    3. Set the name, address, and listening port Telnet service.
      • Name: telnet1
      • Address: 9.1.2.3
      • Port: 5002
    4. Set the address and port for the SSH service.
      • Address: 9.1.2.3
      • Port: 5003
    5. Set the address and port for the web management service.
      • Address: 9.1.2.3
      • Port: 5004
    6. Set the address and port for the XML management service.
      • Address: 9.1.2.3
      • Port: 5005
    7. Set the address and port for the REST management service.
      • Address: 9.1.2.3
      • Port: 5005
    8. Set the server port for the quota enforcement service to 16599.
    9. Set the monitor port for the quota enforcement service to 26599.
  2. Apply and persist the connection details for the tenant.
  3. Access the tenant and persist its configuration.
    1. Open a session to the tenant on the configured web management interface.
    2. Log in to the web with default user name of admin and password of admin and accept the terms of the license agreements.
      The web manage interface restarts.
    3. Log in again to change password for the admin account.
      The interface restarts.
    4. Log in again with the new password, and persist the configuration changes.
  4. Configure API Connect for the tenant from the Cloud Manager Console.
    1. Select the services tab Services tab icon, then click Add service icon Add and select Add DataPower Service.
      The New DataPower Service window appears.
    2. Configure the new DataPower Service with a display name, either the host name or address of the DataPower device, the Management Server port you wish to use for inbound API calls, and the starting port number (Port Base) of a group of ports on the Management Server that are automatically assigned as needed.
      A new service appears under the DataPower Services section.
    3. Click Add Server under the service that you created.
      The New DataPower Server window appears.
    4. Configure the new gateway server with the address of the device that hosts the tenant, the tenant XML management port, the log in credentials you configured, and the network interface configuration of the gateway device. Ensure that the entry matches your device.