wso2/docker-open-banking

Docker and Docker Compose Resources for WSO2 Open Banking

This repository contains the following resources:

• WSO2 Open Banking API Manager Accelerator Module Dockerfile for Ubuntu and Alpine
• WSO2 Open Banking Identity & Access Management Accelerator Module Dockerfile for Ubuntu and Alpine
• Docker Compose resources to evaluate WSO2 Open Banking API Manager with WSO2 Open Banking Identity & Access Management Accelerator Module

Docker resources for WSO2 Open Banking API Manager and WSO2 Open Banking Identity & Access Management Module help you build generic Docker images for deploying the corresponding product servers in containerized environments. Each Docker image includes the JDK, the relevant product distribution and a collection of utility libraries. Configurations, custom JDBC drivers, extensions and other deployable artifacts are designed to be provided via volume mounts to the containers spawned.

Docker Compose resources have been created according to the most common WSO2 Open Banking deployment profiles available for allowing users to quickly evaluate product features along side their co-operate Open Banking requirements. The Compose resources make use of Docker images of WSO2 Open Banking API Manager, WSO2 Open Banking Identity & Access Management Module and MySQL.

Dockerfiles Structure

Outer alpine & ubuntu directories contain the dockerfiles with default jdk versions. The default jdk version of an OB product is the same the base product default jdk version. The default jdk version is mentioned within the brackets below. For other jdk versions, seperate directoriers are maintained.

├── alpine
│     ├── obam (jdk17)
│     ├── obbi (jdk17)
│     └── obiam (jdk11)
├── ubuntu
│     ├── obam (jdk17)
│     ├── obbi (jdk17)
│     └── obiam (jdk11)
└── jdk17
      ├── alpine
      │     └── obiam
      └── ubuntu
            └── obiam

Contributions

For details on how to contribute to this repository, please refer this documentation.

docker-open-banking's Issues

Create Dockerfile for Open Banking Business Intelligence for Alpine

Description:
Dockerfile for Open Banking Business Intelligence(OBBI) should be created to build the OBBI based on adoptopenjdk/openjdk8:jdk8u222-b10-alpine image and run the server

Affected Product Version:
v1.4.0

OS, DB, other environment details and versions:
Alpine

[1.4.0][OB-KM]Docker Alpine Image Fails during the Execution of "docker-compose up"

Description:
When an alpine image from docker.wso2.com is pulled during docker-compose up, was able to observe the following error and couldn't up the OB-KM server.

docker-compose up
Pulling obkm (docker.wso2.com/wso2-obkm:1.4.0.1590163412537.7-alpine3.10)...
1.4.0.1590163412537.7-alpine3.10: Pulling from wso2-obkm
9d48c3bd43c5: Pull complete
617745506915: Pull complete
b0ed4aba78d0: Pull complete
7c4093696c4e: Pull complete
d3e097d210be: Pull complete
2305320c8cee: Pull complete
b8a1c87ad1fe: Pull complete
ac370eb2b69c: Pull complete
e55eae32bdd9: Pull complete
9152d811fef2: Pull complete
mysql is up-to-date
Creating obkm ... done
Attaching to mysql, obkm
obkm | env: can't execute 'bash': No such file or directory
mysql | Initializing database
mysql | 2020-06-02T11:30:10.266857Z 0 [Warning] TIMESTAMP with implicit DEFAULT value is deprecated. Please use --explicit_defaults_for_timestamp server option (see documentation for more details).
mysql | 2020-06-02T11:30:10.443615Z 0 [Warning] InnoDB: New log files created, LSN=45790

Affected Product Version:
1.4.0

Steps to reproduce:

1. Follow the instructions given in [1].
2. Change the docker-compose.yml in [2] to pull an alpine image.
3. Run "docker-compose up".

[1] - https://github.com/wso2/docker-open-banking/blob/1.4.x/docker-compose/obkm/README.md
[2] - https://github.com/wso2/docker-open-banking/blob/1.4.x/docker-compose/obkm/docker-compose.yml

Create Docker Compose Resources for Running OBAM with OBKM on MySQL Database for version 1.5.0

Description:
Docker compose resources should be created to start Open Banking API Manager and Key Manager servers running on MySQL database.

Affected Product Version:
OB 1.5.0

OS, DB, other environment details and versions:
mysql - 5.7.29

Create Docker Compose Resources for Running OBAM and OBKM with OBBI on MySQL Database for version 1.5.0

Description:
Docker compose resources should be created to start Open Banking API Manager, Key Manager and Business Intelligence servers running on MySQL database.

Affected Product Version:
OB 1.5.0

OS, DB, other environment details and versions:
mysql - 5.7.29

Tables not created for geolocationdb

Description:
Tables are missing for openbank_geolocationdb, which causes an error on OBBI-dashboard container.

Fix:
Add scripts to setup.mysql to create tables of openbank_geolocationdb

Create CHANGELOG and Readme for WSO2 Open Banking version 1.5.0

Description:
This PR serves $subject.

Create Docker Compose Resources for Running OBAM with OBKM on MySQL Database for Berlin Spec

Description:
Currently the Docker-Compose resources are available only for UK specification. Docker-Compose resources should be created for the Berlin specification.

Affected Product Version:
v1.4.0

OS, DB, other environment details and versions:
MySQL

Create Docker Compose Resources for Running OBAM with OBKM on MySQL Database

Description:
Docker compose resources should be created to start Open Banking API Manager and Key Manager servers running on MySQL database.

OS, DB, other environment details and versions:
MySQL v5.7

[1.5.0] Support Data Persistence during Apache based Solr Indexing

Description:
It is required to mount to the <OB_AM_HOME>/repository/database directory for persistence during the Solr indexing process [1].

During an empty directory volume mount to this directory, the original/default content within this directory gets erased. Thus, the default content needs to be preserved within the Docker image.

[1]: Apache based Solr indexing

Affected Product Version:
Docker resources for WSO2 Open Banking v1.5.0.1 and above

Add SG Spec Support for OB 1.4.0

Description:
SG spec related configurations and modifications should be added.

Introduce the metadata file required by the infrastructure resource generator

Description:
Introduce the metadata (.metadata) file required by the WSO2 Infrastructure Resource Generator for migrating the Docker and Docker Compose resources between product versions.

Create Docker resources for WSO2 Open Banking version 2.0.0

Description:
Create Dockerfiles for OBAM, OBKM and OBBI for Ubuntu based on adoptopenjdk:8u262-b10-jdk-hotspot-bionic image and for Alpine based on adoptopenjdk/openjdk8:jdk8u272-b10-alpine image. This effort is towards the OB 2.0 docker release.

Affected Product Version:
OB 2.0.0

OS, DB, other environment details and versions:
Ubuntu, Alpine

[1.5.0][AU] Update shell scripts for deploying obam-obkm-with-obbi

Description:

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Create Docker Compose Resources for Running OBAM with OBKM on MySQL Database for version 2.0.0

Description:
Docker compose resources should be created to start Open Banking API Manager and Key Manager servers running on MySQL database.

Affected Product Version:
OB 2.0.0

OS, DB, other environment details and versions:
mysql:5.7.24

Create Docker Compose Resources for OBBI server - AU Specification

Description:
Docker compose resources should be added to start obam-obiam-with-obbi profile for the AU Specification

Affected Product Version
OB-2.0.0

Failure to accept product startup options

Description:
Currently the Docker entrypoint scripts in WSO2 Open Banking use shell scripts. Need to convert them to bash script.
Will have to install bash in alpine for this as well.
This is needed as the current script doesn't allow passing startup options

Update docker compose resources of OBAM and OBIAM

Description:
OBAM and OBIAM Docker compose resources should be added to start obam-obiam-with-obbi profile for the AU Specification

Affected Product Version
OB-2.0.0

[1.5.0] Package the Latest Version of WSO2 Kubernetes Membership Scheme

Description:
It is required to update the WSO2 Kubernetes Membership Scheme to the latest v1.0.7 in the OB Key Manager Docker container images.

Affected Product Version:
Docker resources for WSO2 Open Banking version v1.5.0.2 and above

Sub Tasks:

• Fixed in Alpine based Docker resources
• Fixed in Ubuntu based Docker resources
• Code/Peer review

Create Dockerfile for Open Banking API Manager for Alpine

Description:
Dockerfile for Open Banking API Manager(OBAM) should be created to build the OBAM based on adoptopenjdk/openjdk8:jdk8u222-b10-alpine image and run the server

Affected Product Version:
v1.4.0

OS, DB, other environment details and versions:
Alpine

Create Docker Compose Resources for Running OBAM and OBKM with OBBI on MySQL Database for version 2.0.0

Description:
Docker compose resources should be created to start Open Banking API Manager, Key Manager and Business Intelligence servers running on MySQL database.

Affected Product Version:
OB 2.0.0

OS, DB, other environment details and versions:
mysql:5.7.24

[1.5.0] Review Docker Image Port Definition for WSO2 OB BI Product Profiles

Description:
$subject needs to be conducted and fixed if necessary.

Affected Product Version:
Docker Resources for WSO2 Open Banking v1.5.0.1 and below

Sub Tasks:

• Fixed in Alpine based Docker resources
• Fixed in Ubuntu based Docker resources
• Code/Peer review

Create Docker Compose Resources for Running OBAM with OBIAM on MySQL Database for version 3.0.0

Description:
Docker compose resources should be created to start Open Banking API Manager and Identity and Access Manager Accelerator servers running on MySQL database.

Affected Product Version:
OB 3.0.0

OS, DB, other environment details and versions:
mysql:5.7.24

Refactor 'obkm' to 'obiam', 'Key Manager' to 'Identity & Access Management Module' in v2.0.0.1

Description:
In v2.0.0.1 release we used "obkm" and "Key Manger" to denote Open Banking Identity & Access Management Module. Since we have changed product names from Key Manager to Identity & Access Management Module in OB 2.0 release, OB-IAM component image has been renamed to "wso2-obiam" from "wso2-obkm". This created some issues in docker image build pipeline due to "product_profile_docker_home" being "obkm" rather than "obiam" for the OB-IAM component image. Therefore we have to refactor previously used product names to cater for new changes.

Create CHANGELOG and Readme for WSO2 Open Banking version 2.0.0

Description:
This PR serves $subject.

Change deploy.sh script to change between either specification

Description:
The current deploy script at https://github.com/wso2/docker-open-banking/blob/master/docker-compose/obam-with-obkm/scripts/deploy.sh can change the mount volume to Berlin upon user input. The default config is set to UK.

For developers it would be easier if we add changing the spec from Berlin to UK upon user input as well.

[OB3] Docker build fails due to permission denied for .ashrc file

Description:
The .ashrc file is use to save the MOTD and in obam alpine docker image build process fails due to permission denied for current user. The solution will be to override .ashrc file before changing previledges back to non-root user.

Suggested Labels:

Suggested Assignees:

Affected Product Version:
obam-3.0.0

OS, DB, other environment details and versions:
Alpine

Steps to reproduce:

Related Issues:

Local Entries folder not created in OBAM-OBKM-with-OBBI profile

Description:
In the above profile local-entries folder is not created in /repository/deployment/server/synapse-configs/default path. Due to this API calls cannot be executed.

Add AU spec support for OB 1.4.0

Description:
AU spec related configurations and modifications should be added

[OB3] Docker builds fail due to file extension mismatch of externally given files

Description:
OB3 Dockerfiles accept zip files given from the docker release pipeline as tar.gz files and try to extract them considering them to be tar.gz files. While extracting them (externally passed zip files) using tar command, an error occurs as they aren't properly converted tar.gz files and thus, OB3 docker builds fail.

Suggested Labels:

Suggested Assignees:

Affected Product Version:
obiam-3.0.0, obam-3.0.0

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Preserve the default H2 database data required for Solr indexing process

Description:
It is required to mount to the <OBAM_HOME>/repository/database directory for persistence

Affected Product Version:
Docker resources for WSO2 Open Banking API Manager v1.4.x

[1.5.0] Enable SSL Verification for Wget

Description:
Add SSL certificate verification for wget when downloading the product pack.

Affected Product Version:
Docker Resources for WSO2 Open Banking v1.5.0.1

Sub Tasks:

• Add SSL certificate verification for wget in Alpine based Docker resources
• Add SSL certificate verification for wget in Ubuntu based Docker resources
• Code/Peer review

[SG][Docker] SG specific scope validation configuration is missing in identity.xml

Description:

The SG specific scope validation configuration is missing in the identity.xml and the default scope validator is there. The configuration should be changed to the SG specific one. Following is the config that should be replaced with the default scope validator in the identity.xml file under "ScopeValidators" tag.

<ScopeValidator class="com.wso2.finance.open.banking.identity.extensions.grant.type.handlers.SGJDBCScopeValidator"/>

Cannot build the Docker image of OBAM when localhost is provided as the hosted location

Description:
While WSO2 Open Banking API Manager pack is hosted on localhost of host machine, the docker image cannot be built when localhost is provided as "URL_OF_THE_HOSTED_LOCATION/FILENAME" in the docker build command.

Fix: Add the Docker host machine IP as the "URL_OF_THE_HOSTED_LOCATION/FILENAME" in the docker build command.

Update the main README documentation with information about the Docker Compose resources

Description:
It is required to update the repository's main README documentation with information about the Docker Compose resources.

[1.5.0] Adding the Docker Source Git Release Tag Version to Image Metadata

Description:
Currently, the Docker source Git release tag version is included as part of the Docker image tag (see image tagging mechanism).

Moving forward in order to avoid complexities within the used image tags and improve their clarity, it needs to be evaluated if this value can be added as metadata of the image (using Docker image LABELS).

Sub Tasks:

• Add source label in Alpine based Docker resources
• Add source label in Ubuntu based Docker resources
• Code/Peer review

Related Issues:
wso2/docker-apim#338

Create Dockerfile for Open Banking Business Intelligence

Description:
Dockerfiles are not implemented for this repository yet. Dockerfile for Open Banking Business Intelligence(OBBI) should be created to build the OBBI and run the server

Affected Product Version:
WSO2 Open Banking API Manager v1.4.x

OS, DB, other environment details and versions:
Ubuntu

Related Issues:
#1
#2

Create Dockerfile for Open Banking API Manager

Description:
Dockerfiles are not implemented for this repository yet. Dockerfile for Open Banking API Manager(OBAM) should be created to build the OBAM and run the server

Affected Product Version:
WSO2 Open Banking API Manager v1.4.x

OS, DB, other environment details and versions:
Ubuntu

Create Docker resources for WSO2 Open Banking version 1.5.0

Description:
Dockerfile for Open Banking API Manager(OBAM) should be created to build the OBAM based on adoptopenjdk:11.0.6_10-jdk-hotspot-bionic image and run the server

Affected Product Version:
OB 1.5.0

OS, DB, other environment details and versions:
ubuntu, alpine

MySQL container resets max_connections during runtime.

Description:
The MySQL 5.7 container restarts after executing the script, which resets the max_connections to 151(Default value). The setting of max_connections at the beginning is not permanent.

Create Dockerfiles for Open Banking V3.0.0 APIM and IAM Accelerators

Description:
The Dokcerfiles for OBAM and OBIAM Accelerator Modules should be created for both Ubuntu and Alpine OSs in order to build docker images for those products.

Affected Product Version:
OB 3.0.0

OS, DB, other environment details and versions:
Ubuntu | Alpine

[OBKM] Reducing the docker image size

Description:
This issue is created to track the docker image size reduction.

Suggested Labels:
OBKM

[1.5.0][AU] Update shell scripts for deploying obam-with-obkm

Description:

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

Add a change log to this repository

Description:
A change log should be introduced to this repository to indicate the changes that occur across each release performed.

The format suggested at [1] can be used in the change log.

[1]: Change log format

Create Dockerfile for Open Banking Key Manager for Alpine

Description:
Dockerfile for Open Banking Key Manager(OBKM) should be created to build the OBKM based on adoptopenjdk/openjdk8:jdk8u222-b10-alpine image and run the server

Affected Product Version:
v1.4.0

OS, DB, other environment details and versions:
Alpine

[1.5.0] Review Docker Image Port Definition for WSO2 OB Key Manager

Description:
Currently, the ports defined are 9763, 9443 and 9446. The correct set of ports to be exposed are 9766 and 9446.

Affected Product Version:
Docker Resources for WSO2 Open Banking v1.5.0.1 and below

Sub Tasks:

• Fixed in Alpine based Docker resources
• Fixed in Ubuntu based Docker resources
• Code/Peer review

Create Deployment Script for the Docker Compose Resources of WSO2 Open Banking API Manager with Open Banking Key Manager deployment

Description:
Create a deployment script similar to https://github.com/wso2/docker-apim/blob/master/docker-compose/apim-is-as-km-with-analytics/scripts/deploy.sh which will deploy the required specification of the user.

Create Docker Compose Resources for Running OBAM and OBKM with OBBI on MySQL Database

Description:
Docker compose resources should be created to start Open Banking API Manager, Key Manager and Business Intelligence servers running on MySQL database.

OS, DB, other environment details and versions:
MySQL v5.7

[OB3] Duplicate key IdentifierExecutors in OB-IS

Description:
Getting a “Duplicate key IdentifierExecutor” error when trying to update a SP created using /oauth2/dcr endpoint. This issue occurs when the org.wso2.carbon.identity.application.authentication.handler.identifier-6.3.11.11.jar is present in <IS_HOME>/repository/components/dropins directory.

Affected Product Version: OB3

OS, DB, other environment details and versions:

Steps to reproduce:
Create a new client with DCR
Login to IS console
Change Authentication Type to Federated Authentiction under "Local & Outbound Authentication Configuration" of the Service Provider

Related Issues:
https://support-internal.wso2.com/jira/browse/OBINTERNAL-862

Create Dockerfile for Open Banking Key Manager

Description:
Dockerfiles are not implemented for this repository yet. Dockerfile for Open Banking Key Manager(OBKM) should be created to build the OBKM and run the server

Affected Product Version:
WSO2 Open Banking API Manager v1.4.x

OS, DB, other environment details and versions:
Ubuntu

Related Issues:
#1

OBAM-OBKM-with-OBBI has "Berlin" as the default specification

Description:
The default specification for the product pack should be 'UK'. But the current Docker Compose file has 'Berlin' as the default spec. This should be changed to 'UK'