IBM Support

What are the recommended topologies for API Connect Clouds?

Question & Answer


Question

What are the recommended topologies for API Connect Clouds?

Answer

On Demand Consulting
Author: Uday Pilai


Overview

This article describes the recommended topologies for API Connect.

Intended Audience

Administrators planning to build a highly available API Connect Cloud

Key Components in an API Connect Topology

By configuring multiple Management servers and multiple Gateway servers, your cloud benefits from high availability (HA). When you define more than one Management server, configure an external load balancer. Then, if one server is removed for planned maintenance or an unplanned failure, your users can continue to access the cloud. The more servers that you add the greater the ability of your cloud to withstand outages and continue to provide processing capability.

Gateway Servers

Process and manage security protocols and stores relevant user and appliance authentication data. The Gateway servers also provide assembly functions that enable APIs to integrate with various endpoints such as databases or HTTP-based endpoints.

Management Servers

Manage the operations of the various servers in the API Cloud. The Management servers also provide analytic functions that collect and store information about APIs and API users.

Advanced Developer Portal

The Advanced Developer Portal enables API providers to build a customized developer portal for their application developers.

Collective Servers

A collection of runtime environments for APIs that have been created. The collective is also used as the runtime for the Micro Gateway.
User-added image

Typical API Connect Production Topology

Common "production like" environments will include:

  • Management Service: 2 Management Servers
  • Developer Portal Service: 3 Advanced Developer Portal Servers
  • DataPower Service: 2 AppliancesDataPower
Note : The term "production like" environment is used instead of production environment as customers will often have a pre-production environment that mirrors the configuration of the production environment.
User-added image

API Connect Topology - Data Center View

User-added image

Typical Non-Production (DevtestQA) API Connect topology

A typical non-production environment will include a single server for each of the following deployable units:
  • Management Server
  • Developer Portal
  • DataPower Gateway (virtual appliance)
User-added image

 

[{"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSQTW3","label":"IBM On Demand Consulting for Hybrid Cloud"},"Component":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"","label":""}}]

Document Information

Modified date:
26 March 2019

UID

ibm10773011