This documentation is for WSO2 Open Banking version 1.5.0. View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

WSO2 Open Banking Key Manager clustered deployment takes high availability (HA) into consideration and is recommended for production deployment environments. The following sections provide high level information on the recommended deployment pattern available and point off to instructions on how to set up and configure the deployment. 

Deployment prerequisites

As a first step in planning your deployment, ensure that you have the necessary system requirements and a compatible environment.

System requirements


4GB: 2 GB for the Java Virtual Machine (JVM) and 2 GB for the Operating System (OS)

Disk10 GB minimum

Environment compatibility

Operating systems

For information on tested operating systems, see Tested Operating Systems and JDKs.


For information on tested DBMSs, see Tested DBMSs.

Directory services

Supports Directory Services implementing the following LDAP Protocols:

  • LDAP v2
  • LDAP v3

For information on tested LDAPs, see Tested LDAPs.

JavaOracle JDK 1.8 (There’s a known issue with JDK1.8.0_151)
Web browsers

For more information on tested web browsers, see Tested Web Browsers.

Load balancers

For more information about load balancers, see Configuring the load balancer.

Deployment Pattern

Before you begin:

  1. Ensure high availability for the respective RDBMS and Directory Services used for the deployment pattern given below.

  2. 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.

    • The Runtime deployment artifacts for secondary user stores are in /repository/deployment/server/userstores/

HA clustered deployment of WSO2 Open Banking Key Manager

This deployment can be scaled from two to N number of nodes based on capacity requirements. 

  • The load balancer should be configured to use sticky sessions

  • All WSO2 Open Banking Key Manager nodes should participate in a cluster. As cache updates happen, clustering is used to invalidate local caches of nodes by notifying over cluster messages.

Setting up deployment

To set up and configure a clustered deployment of WSO2 Open Banking Key Manager, see Setting Up Open Banking Key Manager Deployment.

Open ports


WSO2 Open Banking

Key Manager

9766HTTP servlet port
9446HTTPS servlet port
4000Ports to be opened with respect to clustering membership scheme used
  • No labels