Puppet Modules for WSO2 Open Banking

This repository contains the Puppet modules for WSO2 Open Banking.

Quick Start Guide

1. Download the following zip files:
   

   • wso2is-5.11.0.zip
     
   • wso2am-4.0.0.zip
     
   • wso2si-4.0.0.zip
     
   • wso2ob-is-accelerator-3.0.0.zip
     
   • wso2ob-apim-accelerator-3.0.0.zip
     
   • wso2ob-bi-accelerator-3.0.0.zip
     

   Copy them to the <puppet_environment>/modules/ob_common/files/packs directory in the Puppetmaster.

2. Set up the JDK distribution as follows:

   The Puppet modules for WSO2 Open Banking use Oracle JDK 8 as the JDK distribution. However, you can use any supported JDK distribution.

   a. Download Java SE Development Kit 8u161 for Linux x64 from here and copy the archive into the <puppet_environment>/modules/ob_common/files/jdk directory of Puppetmaster.
   (please make sure that the name of the archive matches with the name of the extracted folder Ex: jdk1.8.0_161)
   b. Reassign the $jdk_name variable in <puppet_environment>/modules/ob_common/manifests/params.pp to the name of the downloaded JDK distribution.

3. Change the hostnames in <puppet_environment>/modules/ob_common/manifests/params.pp of Puppetmaster.

4. Set up the databases in the Puppet agent by following the Configuring Databases documentation.
   Update the <puppet_environment>/modules/ob_common/manifests/params.pp file of Puppetmaster to point the created databases.

5. Run the following profiles on the Puppet agent, by executing the following commands.

   a. To run the Open Banking Business Intelligence profile:

    export FACTER_profile=obbi
    puppet agent -vt
   

   b. To run the Open Banking Identity Server profile:

    export FACTER_profile=obiam
    puppet agent -vt
   

   c. To run the Open Banking API Manager profile:

    export FACTER_profile=obam
    puppet agent -vt
   

6. To use a custom Java KeyStore (JKS) file in the Open Banking Identity Server, Open Banking API Manager and Open Banking Business Intelligence profiles, follow the steps below:

   a. Create a custom JKS by following the steps in the Creating New Keystores documentation.

   b. Create the following directories in the Puppetmaster:

     <puppet_environment>/modules/obbi/files/resources/security
     <puppet_environment>/modules/obam/files/repository/resources/security
     <puppet_environment>/modules/obiam/files/repository/resources/security
   

   c. Copy the custom JKS file into the above directories.
   

   d. Update the $file_list variable in the files below, with the custom JKS file path (repository/resources/security/custom_jks.jks).
   

    <puppet_environment>/modules/obbi/manifests/params.pp
   
        $file_list = ['resources/security/custom_jks.jks',] 
   
     <puppet_environment>/modules/obam/manifests/params.pp
   
        $file_list = ['repository/resources/security/custom_jks.jks',] 
   
     <puppet_environment>/modules/obiam/manifests/params.pp
   
        $file_list = ['repository/resources/security/custom_jks.jks',] 
   

Manifests in a module

The run stages for Puppet are described in <puppet_environment>/manifests/site.pp, and they follow the given order Main -> Custom.

Each Puppet module contains the following .pp files.

• Main
  • params.pp: Contains all the parameters required for main configuration and template.
  • init.pp: Contains the main script of the module.
• Custom
  • custom.pp: To add custom configurations to the Puppet module.

Customizations

When updating the <puppet_environment>/modules/ob_common/manifests/params.pp file of Puppetmaster to point the created databases, change the configurations based on the database type (mysql/oracle/mssql).

For mysql/mssql:
```$<db_name>_validation_query        = 'SELECT 1'```

For oracle:
```$<db_name>_validation_query  = 'SELECT 1 FROM DUAL'```