Running the Configurator with a Template Module

You can use the Configurator to seamlessly automate the configuration process that needs to be carried out when configuring Private PaaS (PPaaS) and the cartridges used in PPaaS. For more information, see Configurator.

Follow the instructions below to run the Configurator with the Template Module:

Step 1 - Install Prerequisites

Install Python pip.
```
sudo apt-get install python-pip
```
Install jinja2 module.
```
sudo pip install Jinja2
```

Step 2 - Download Configurator

The Configurator is hosted on the Private PaaS Cartridge Repository. Download the Configurator via the PPaaS product page on the WSO2 website.

Step 3 - Create a Template Module (Optional)

The WSO2 Private PaaS Cartridge Repository contains a list of Cartridges with Template Modules that can be built. You need to follow the instructions below only if you wish to create a new template module for a WSO2 product.

Create the Template Module with the following folder structure. For more information, see Template Module.

├── files
├── templates
└── module.ini

Step 4 - Build the Template Module

Download the respective WSO2 product cartridge via the PPaaS product page and unzip it.

Navigate to the Template Module.

cd <TEMPLATE_MODULE_PATH>

Example:

cd <wso2am-1.9.1-cartridge-4.1.0>/template-module/

Build the Template Module.
```
mvn clean install 
```

Unzip the resulting ZIP file.

cd <PPAAS_CARTRIDGE_HOME>
unzip  <BUILT_TEMPLATE_MODULE_PATH>/<TEMPLATE_MODULE_ZIP>

Example:

cd <wso2am-1.9.1-cartridge-4.1.0>
unzip <wso2am-1.9.1-cartridge-4.1.0>/template-module/target/wso2am-1.9.1-template-module-4.1.0.zip

Step 5 - Define the configuration parameters

Define the configuration parameters in the module.ini file within the respective template module. To see parameter definitions navigate to the respective README.md file within the template module.
For example the API Manager 1.9.1 README.md is available in the <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.1/template-module directory.

It is mandatory to set the following configuration parameters: READ_FROM_ENVIRONMENT and CARBON_HOME.

Step 6 - Execute the Configurator on the Template Module

Navigate to the Configurator folder.
```
cd <CONFIGURATOR_HOME>
```

Pass the template module folder as a command line argument and execute Configurator.

./configurator.py -d <PATH_TO_TEMPLATE_MODULE>

Example:

./configurator.py -d /tmp/wso2am-1.9.1-template-module-4.1.0