Open Banking API Management High Availability Deployment

The WSO2 Open Banking API Management (WSO2 OB APIM) module is used for creating and publishing APIs, and routing API traffic scalably. It consists of the following components:

Publisher
Store
Gateway
Traffic Manager

Typically, when you get started with the API Manager in a development environment, you deploy the API Manager as a single instance with all its components on a single server. However, in a production deployment, the components are deployed in a distributed manner. Therefore, you can create a distributed deployment of the main components. This page describes the recommended patterns for a WSO2 Open Banking API Management high availability deployment.

Deployment Patterns

Before you begin:

Ensure high availability for the respective RDBMS and Directory Services used for the deployment pattern given below.
In each production deployment, share the runtime deployment artifacts among nodes using a shared file system. In the deployment pattern defined below, this process is referred to as Artifact synchronization (Artifact sync).
The Runtime deployment artifacts are:
1. Synapse configurations
  /repository/deployment/server/synapse-configs
2. Throttling policies
  /repository/deployment/server/executionplans
Persist the following file directories in each API Manager node:
1. Apache Solr-Based Indexing files
  /solr
2. H2 database files
  /repository/database

Pattern 1

Single node (all-in-one) deployment with API Management (WSO2 OB APIM) and Identity and Access Management (WSO2 OB IAM) servers.

You can use this pattern when you are working with low throughput.

Pattern 1 - High Availability

Multi-node deployment with API Management (WSO2 OB APIM) and Identity and Access Management(WSO2 OB IAM) servers.

Pattern 2

Single node deployment with API Management (WSO2 OB APIM), Identity and Access Management (WSO2 OB IAM), and WSO2 Open Banking Business Intelligence (WSO2 OB BI) servers.

Pattern 2 - High Availability

Multi-node deployment with API Management (WSO2 OB APIM), Identity and Access Management (WSO2 OB IAM), and WSO2 Open Banking Business Intelligence (WSO2 OB BI) servers.

Pattern 3

Multi-node deployment with separate Gateways, API Management (WSO2 OB APIM), Identity and Access Management (WSO2 OB IAM), and WSO2 Open Banking Business Intelligence (WSO2 OB BI) servers.

Setting up deployment

To set up and configure a HA deployment of API Manager, see the following documentation:

Open ports

Product	Port	Usage
WSO2 Open Banking API Manager	9763	HTTP servlet port
	9443	HTTPS servlet port
	8280,8243	NIO/PT transport ports

Scaling the Gateway

For deployments like Pattern 3, the Gateway can be scaled based on the load that the Gateways will handle. We recommend that a load test be carried out on the Gateways in the environment. For more information on what factors affect the load, and how the numbers have to be derived in order to scale, see the article on Capacity Planning. Make sure to check the backends as well for the expected load.