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 count in 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 in to a simple module.ini file, which includes all the parameters that are configurable in that specific Cartridge.
Template Module
The Configurator operates on a set of configuration templates called 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.
├── files
├── templates
└── module.ini
files
The files folder contains the static files which do not require any template processing. For example, mysql-connector-java-5.1.36.jar file should go inside the files folder.
templates
The templates folder contains of the configurable template files. For example, if clustering can be configured in a particular template module for a Carbon product, the axis2.xml file should be included in the templates folder as a templated file, axis2.xml.template. The template file content for the clustering related area can look like something as follows.
module.ini
The module.ini file contains the configurable options for the specific template module. For example, for the above mentioned clustering enabled axis2.xml.template file, the following can be the likely entries of the module.ini file.
[SETTINGS]
READ_FROM_ENVIRONMENT=true
CARBON_HOME=/opt/wso2am-1.9.1
[PARAMS]
CONFIG_PARAM_CLUSTERING=true
CONFIG_PARAM_MEMBERSHIP_SCHEME=wka
CONFIG_PARAM_DOMAIN=wso2.carbon.domain
CONFIG_PARAM_LOCAL_MEMBER_HOST=127.0.0.1
CONFIG_PARAM_LOCAL_MEMBER_PORT=4000
CONFIG_PARAM_WKA_MEMBERS=[127.0.0.1:4000]
CONFIG_PARAM_PORT_OFFSET=0
CONFIG_PARAM_PROFILE=Default
Running the Configurator