WSO2 Open Banking API Manager (WSO2 OB APIM) is used for creating and publishing APIs, and routing API traffic scalably. WSO2 OB APIM consists of the following components:
- Traffic Manager
Typically, when you get started with WSO2 OB APIM in a development environment, you deploy WSO2 OB APIM 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 OB APIM high availability deployment.
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:
Persist the following file directories in each WSO2 Open Banking API Manager node:
Apache Solr-Based Indexing files
H2 database files
Single node (all-in-one) deployment with WSO2 OB APIM and WSO2 Open Banking Key Manager (WSO2 OB KM).
You can use this pattern when you are working with low throughput.
Pattern 1 - High Availability
Multi-node deployment with API Manager (WSO2 OB APIM) and Key Manager (WSO2 OB IAM) servers.
Single node deployment with API Manager (WSO2 OB APIM), Key Manager (WSO2 OB IAM), and WSO2 Open Banking Business Intelligence (WSO2 OB BI) servers.
Pattern 2 - High Availability
Multi-node deployment with API Manager (WSO2 OB APIM), Key Manager (WSO2 OB IAM), and WSO2 Open Banking Business Intelligence (WSO2 OB BI) servers.
Multi-node deployment with separate Gateways, API Manager (WSO2 OB APIM), Key Manager (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 WSO2 Open Banking API Manager, see the following topics:
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.