Skip to content

wso2/puppet-open-banking

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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:

    • wso2-obkm-1.4.0.zip
    • wso2-obam-1.4.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](https://www.oracle .com/technetwork/java/javase/downloads/java-archive-javase8-2177648.html) and copy the archive into the <puppet_environment>/modules/ob_common/files/jdk directory.
    (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. Set up the databases by following the [Configuring Databases](https://docs.wso2 .com/display/OB140/Configuring+Databases) documentation.

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

    a. To run the Open Banking Key Manager profile:

     export FACTER_profile=obkm
     puppet agent -vt
    

    b. To run the Open Banking API Manager profile:

     export FACTER_profile=obam
     puppet agent -vt
    
  5. To use a custom Java KeyStore (JKS) file in Open Banking Key Manager and Open Banking API Manager, 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/obam/files/repository/resources/security
      <puppet_environment>/modules/obkm/files/repository/resources/security
    

    c. Copy the custom JKS file into both 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/obam/manifests/params.pp
    
         $file_list = ['repository/resources/security/custom_jks.jks',] 
    
      <puppet_environment>/modules/obkm/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.