Page Comparison

The newly introduced Configurator component aims to tackle the cumbersome task of product and instance configuration with complex requirements. In the case of a Cartridge instance, there are numerous run-time factors that you need to take into account for the correct configuration to take place. Some of these factors include clustering and database information, the role of the Cartridge type in the clustering context and even the role of the Cartridge on the product specific distributed setup (such as that of WSO2 API Manager). The Configurator simplifies these factors into a simple module.ini file, which includes all the parameters that are configurable in that specific Cartridge. Thereby, you can use the configurator to seamlessly automate the configuration process that needs to be carried out when configuring Private PaaS and its cartridges. 

Template Module

The Configurator operates on a set of configuration templates, which are referred to as a Template Module. A Template Module should be of the following folder structure and should contain the files and templates, which are needed to configure the specific Cartridge.

...

Running the Configurator

The Configurator has to be pointed is hosted on the Private PaaS Cartridge Repository. When running the configurator you have to point to the location of the template module. It will look for the module.ini file, read the configuration values, process the templates inside templates folder, and copy the processed templates and the files inside files folder to the CARBON_HOME. 

Download Configurator

The Configurator is hosted on the Private PaaS Cartridge Repository. 

1. Checkout the Cartridge Repository.

Create Template Module

Create the template module with the above mentioned folder structure. However, Private PaaS Cartridge Repository contains a list of Cartridges with Template Modules that can built. For example, if we are building the template module for WSO2 API Manager the following procedure can be followed. 

1. Checkout the Private PaaS Cartridge repository.

   Code Block
   git clone https://github.com/wso2/private-paas-cartridges.git

2. Navigate to WSO2 API Manager 1.9.1 Template Module.

   Code Block
   cd <PRIVATE_PAAS_CARTRIDGES_HOME>/wso2am/1.9.1/template-module/

3. Build the Template Module.

   Code Block
   mvn clean install

4. Unzip the resulting ZIP file.

   Code Block
   cd /tmp unzip <PRIVATE_PAAS_CARTRIDGES_HOME>/wso2am/1.9.1/template-module/target/wso2am-1.9.1-template-module-4.1.0.zip

Execute Configurator on the Template Module

Navigate to the Configurator folder and execute configurator.py, and pass the template module folder as a command line argument. 

Example:

...

...

For details steps on running the configurator, see Running the Configurator.