Deploy with Docker

The Docker images for WSO2 Open Banking Accelerators contain the extracted Accelerator modules with the latest update levels. These images are not standalone runtime images. Instead, they are designed to be used as base components for building container images of:

  • WSO2 API Manager with the Financial Services API Management Accelerator Module
  • WSO2 Identity Server with the Financial Services Identity & Access Management Accelerator Module

Supporting Resources

In addition to the Accelerator Docker images, users can refer to the following resources provided as guides for building and deploying containerized images. All resources can be downloaded from the Open Banking Docker GitHub Repository.

Sample Dockerfiles

Use these as references to:

  • Deploy the WSO2 Open Banking API Manager Accelerator Module on top of WSO2 API Manager
  • Deploy the WSO2 Open Banking Identity & Access Management Accelerator Module on top of WSO2 Identity Server

The sample Dockerfiles helps to build generic Docker images for deploying the respective product servers in containerized environments. Each image includes the JDK, the relevant product distribution, and a set of utility libraries, configurations, custom JDBC drivers, extensions, and other deployable artifacts.

Docker Compose Resources

Docker Compose resources are available helps to quickly evaluate the Open Banking setup by deploying:

  • WSO2 Open Banking Accelerator installed WSO2 Open Banking API Manager, together with
  • WSO2 Open Banking Accelerator installed WSO2 Open Banking Identity & Access Management

These resources have been created based on the most common WSO2 Open Banking deployment profiles, allowing users to evaluate product capabilities against their organization’s Open Banking requirements. The Compose setup utilizes the Docker images built using Dockerfiles mentioned in Sample Dockerfiles.

Before you begin:

  1. Install Git, Docker, and Docker Compose to get started.

  2. Clone the wso2/docker-open-banking repository. This document refers to the file path of the cloned directory as <OB_DOCKER_HOME>.

Note

In order to use WSO2 Open Banking Docker Images, you need an active WSO2 Open Banking subscription. If you don't have a WSO2 Open Banking subscription, contact us for more information.

Build Container Docker Images

Prerequisites

  1. Zip archive file of the Open Banking root and issuer certificates.

    • Download the root and issuer certificates.
    • Rename the OB_SandBox_PP_Root.cer as root.cer.
    • Rename the OB_SandBox_PP_Issuing.cer as issuer.cer.
    • Zip the root.cer and issuer.cer in one zip archive file.

  2. Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images.

  3. DB driver file matching to the DB type and version use for the deployment.

  4. Host the downloaded artifacts locally or on a remote location. The hosted locations of artifacts will be passed as the build arguments when building the Docker image.

    • OB_TRUSTED_CERTS_URL - Zip archive location of the certificates of WSO2 Open Banking root and issuer
    • WSO2_OB_KEYSTORES_URL - Location of keystores folder of wso2 server certs
    • RESOURCE_URL - Location of the DB driver file and Custom Error Formatter XML

Update database details in the Dockerfiles

  1. Setup Databases for WSO2 API Manager and WSO2 Open Banking Identity Server.
  2. Update database details in the Dockerfiles inside <OB_DOCKER_HOME>/samples/wso2is_with_obiam and <OB_DOCKER_HOME>/samples/wso2am_with_obam.

Build container image for WSO2 Identity Server

This steps builds the container image for WSO2 Identity Server with WSO2 Open Banking Identity and Access Management Accelerator Module

  1. Navigate to <OB_DOCKER_HOME>/samples/wso2is_with_obiam directory.

  2. Execute docker build command as shown below.

    docker build --build-arg BASE_PRODUCT_VERSION=<IS_VERSION> --build-arg OB_TRUSTED_CERTS_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg WSO2_OB_KEYSTORES_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg RESOURCE_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> -t wso2is-ob:4.0.0 .
    docker build --build-arg BASE_PRODUCT_VERSION=7.1.0 --build-arg OB_TRUSTED_CERTS_URL=http://localhost:8000/trusted-certs.zip --build-arg WSO2_OB_KEYSTORES_URL=http://localhost:8000/docker-open-banking/samples/keystores/ --build-arg RESOURCE_URL=http://localhost:8000 -t wso2is-ob:4.0.0 .
    docker build --build-arg BASE_PRODUCT_VERSION=7.1.0 --build-arg OB_TRUSTED_CERTS_URL=http://<public_ip:port>/trusted-certs.zip --build-arg WSO2_OB_KEYSTORES_URL=http://<public_ip:port>/docker-open-banking/samples/keystores/ --build-arg RESOURCE_URL=http://<public_ip:port> -t wso2is-ob:4.0.0 .

Build container image for WSO2 API Manager

This step builds container image for WSO2 API Manager with WSO2 Open Banking API Management Accelerator Module

  1. Navigate to <OB_DOCKER_HOME>/samples/wso2am_with_obam directory.

  2. Execute docker build command as shown below.

    docker build --build-arg BASE_PRODUCT_VERSION=<APIM_VERSION> --build-arg OB_TRUSTED_CERTS_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg WSO2_OB_KEYSTORES_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg RESOURCE_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> -t wso2am-ob:4.0.0 .
    docker build --build-arg BASE_PRODUCT_VERSION=4.5.0 --build-arg OB_TRUSTED_CERTS_URL=http://localhost:8000/trusted-certs.zip --build-arg WSO2_OB_KEYSTORES_URL=http://localhost:8000/docker-open-banking/samples/keystores/ --build-arg RESOURCE_URL=http://localhost:8000 -t wso2am-ob:4.0.0 .
    docker build --build-arg BASE_PRODUCT_VERSION=4.5.0 --build-arg OB_TRUSTED_CERTS_URL=http://<public_ip:port>/trusted-certs.zip --build-arg WSO2_OB_KEYSTORES_URL=http://<public_ip:port>/docker-open-banking/samples/keystores/ --build-arg RESOURCE_URL=http://<public_ip:port> -t wso2am-ob:4.0.0 .

If you are looking for a Quick Start Guide and deploy the solution, follow Deploy WSO2 Open Banking with Docker Compose.

If you want to deploy each Open Banking component in separate containers, follow Deploy WSO2 Open Banking with Docker.

To learn how to download WSO2 Updates for Open Banking Images, see Download WSO2 Updates.

Deploy WSO2 Open Banking with Docker Compose

This section explains how to deploy the solution using Docker Compose.

Note

This is a Quick Start Guide to set up the solution in your local environment.

Before you begin:

Build the Container docker images for WSO2 IS with WSO2 OBIAM Accelerator and WSO2 AM with WSO2 OBAM Accelerator as mentioned in Build Container Docker Images Section.

  1. Go to the samples/docker-compose/wso2am-with-wso2is directory inside the <OB_DOCKER_HOME> directory.

    cd <OB_DOCKER_HOME>/samples/docker-compose/wso2am-with-wso2is

  2. Deploy the solution by executing the following command:

    docker-compose up

Deploy WSO2 Open Banking with Docker

This section explains how to set up the solution using WSO2 Open Banking Docker images.

Set up Network

  • Create a network.

    docker network create -d bridge ob-network

Set up Open Banking Identity Server with Docker

  1. Run the container image for WSO2 Identity Server with WSO2 Open Banking Identity and Access Management Accelerator Module.

    docker run -it -p 9446:9446 --network ob-network --name obiam wso2is-ob:4.0.0

Set up Open Banking API Manager with Docker

  1. Run the container image for WSO2 API Manager with WSO2 Open Banking API Management Accelerator Module.

    docker run -p 9443:9443 -p 8243:8243 -p 8280:8280 --network ob-network --name obam wso2am-ob:4.0.0

Accessing the Servers

  1. Add the below entry mappings into the /etc/hosts file of your host machine.

    • 127.0.0.1 obam
    • 127.0.0.1 obiam

  2. You can access the WSO2 Open Banking API Manager using a web browser via the following URLs:

    • https://obam:9443/publisher
    • https://obam:9443/devportal
    • https://obam:9443/admin
    • https://obam:9443/carbon

  3. The API Gateway will be available on the following ports:

    • https://obam:8243
    • http://obam:8280

  4. You can access the WSO2 Open Banking Identity Server using a web browser via the following URL:

    • https://obiam:9446/carbon
Top