This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Page Comparison - Cartridge Payload Property Definitions (v.4 vs v.13) - WSO2 Private PaaS 4.1.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The following are the definitions of the payload parameters passed the cartridge JSON:

Table of Contents

General payload property definitions

Property NameClustered SetupStandalone
Setup 
DescriptionExample Values
ManagerWorker
COMMIT_ENABLEDYesNoNoThis enables auto commit in Python Cartridge Agent (PCA). Once you give define a git Git repository when creating an application or when signing up, the PCA will commit the changes.true - for a manager in a clustered setup
false - for a standalone setup 
CONFIG_PARAM_CLUSTERINGYesYesYesTo enable clustering in WSO2 Productsproducts.true - for a clustered setup
false - for a standalone setup 
CONFIG_PARAM_LB_IP, LB_IP
YesYesNoDefines the load balancer Load Balancer IP which is fronted by the cartridge.127.0.0.1
CONFIG_PARAM_REGISTRY_DB_URL,
CONFIG_PARAM_REG_DB_URL 
YesYesNoRegistry URL of registry database url.jdbc:mysql://172.17.8.1:3306/registry_44x
CONFIG_PARAM_REGISTRY_DB_USER_NAMEYesYesNoRegistry Username of registry database username.root
CONFIG_PARAM_REGISTRY_DB_PASSWORDYesYesNoRegistry Password of registry database password.root
CONFIG_PARAM_REGISTRY_DB_DRIVERYesYesNoDriver class name used in the data source.com.mysql.jdbc.Driver
CONFIG_PARAM_CONFIG_DB_URLYesYesNoConfig database urlURL of the config database.jdbc:mysql://172.17.8.1:3306/config_db_as_530
CONFIG_PARAM_CONFIG_DB_USER_NAMEYesYesNoConfig database usernameUsername of the config database.root
CONFIG_PARAM_CONFIG_DB_PASSWORDYesYesNoConfig database passwordPassword of the config database.root
CONFIG_PARAM_CONFIG_DB_DRIVERYesYesNoDriver class name used in the data source.
com.mysql.jdbc.Driver
CONFIG_PARAM_USER_MGT_DB_URL, CONFIG_PARAM_UM_DB_URL YesYesNoUser Management database urlURL of the user management database.jdbc:mysql://172.17.8.1:3306/userstore_44x
CONFIG_PARAM_USER_MGT_DB_USER_NAMEYesYesNoUser Management database usernameUsername of the user management database.root
CONFIG_PARAM_USER_MGT_DB_PASSWORDYesYesNoUser Management database passwordPassword of the user management database.root
CONFIG_PARAM_USER_MGT_DB_DRIVERYesYesNoDriver class name used in the data source.com.mysql.jdbc.Driver
CONFIG_PARAM_PROFILEYesYesYes

Defines the profile name used in the WSO2 product. Based on the The configurations vary based on this profile name, there are configuration changes.

Info

This payload parameter is only common for the AM and DAS cartridges.

Gateway-Manager, Gateway-Worker, default
CONFIG_PARAM_MEMBERSHIP_SCHEME
NoNoYes

Membership scheme name used for cluster discovery.

private-paas, wka
CONFIG_PARAM_WORKER_HOST_NAMENoNoYes

Host name Hostname of the worker node or default node.

as.wso2.com
APPLICATION_PATHNoNoYes

Application The application path which that is used to clone the git Git artifacts.

/var/www
CONFIG_PARAM_PORT_OFFSETYesYesYesThis allows you to run multiple WSO2 products, multiple instances of a WSO2 product, or multiple WSO2 product clusters on the same server or virtual machine (VM). The port offset defines the number by which all ports defined in the runtime such as the HTTP/S ports will be offset. For example, if the HTTP port is defined as 9763 and the portOffset is 1, the effective HTTP port will be 9764. Therefore, for each additional WSO2 product, instance, or cluster you add to a server, set the port offset to a unique value (the default is 0).1

 

AM specific payload properties

Property NameClustered
Setup
Standalone
Setup 
DescriptionExample Values
ManagerWorker
CONFIG_PARAM_APIMGT_DB_URLYesYesYesURL of the API_Mgt related database url .jdbc:mysql://172.17.42.1:3306/apimgtdb
CONFIG_PARAM_APIMGT_DB_USER_NAMENoNoYesUsername of the API_Mgt database username.root
CONFIG_PARAM_APIMGT_DB_PASSWORDNoNoYesPassword of the API_Mgt database password.root
CONFIG_PARAM_KEYVALIDATORCLIENTTYPE
Yes
YesNoKey validator client type used in API Manager.WSClient
CONFIG_PARAM_DOMAINYesYesNoDomain name to be used in the deployment.wso2.pub.store.domain

 

DAS cartridge specific payload properties 

CONFIG_PARAM_MEMBERSHIP_SCHEME
Property NameStandalone
Setup 
DescriptionExample ValuesMembership scheme name used for cluster discoveryprivate-paas
CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_URLYesURL of the WSO2_ANALYTICS_FS DB. This is used for the file system. 


jdbc:mysql://192.168.52.203:3306/ANALYTICS_FS_DB?autoReconnect=true

CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_USER_NAMEYesUsername of the WSO2_ANALYTICS_FS DB.root
CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_PASSWORDYesPassword of the WSO2_ANALYTICS_FS DB.root
CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_DRIVERYesDriver class name used in the data source.com.mysql.jdbc.Driver
CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_URLYesURL of the WSO2_ANALYTICS_EVENT_STORE DB. This is used for event store. 


jdbc:mysql://192.168.52.203:3306/ANALYTICS_EVENT_STORE?autoReconnect=true

CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_USER_NAMEYesUsername of the WSO2_ANALYTICS_EVENT_STORE DB.root
CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_PASSWORDYesPassword of the WSO2_ANALYTICS_EVENT_STORE DB.root
CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_DRIVERYesDriver class name used in the data source.com.mysql.jdbc.Driver
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_URLYesURL of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_ DB. This is used for managing to manage processed data. jdbc:mysql://192.168.52.203:3306/ANALYTICS_PROCESSED_DATA_STORE?autoReconnect=true
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_USER_NAMEYesUsername of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_ DB. root
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_PASSWORDYesPassword of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_ DB. root
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_DRIVERYesDriver class name used in the data sourcecom.mysql.jdbc.Driver

 

MB cartridge specific payload properties

Property NameStandalone
Setup 
DescriptionExample Values
CONFIG_PARAM_MB_METRICS_DB_URLYesURL of the MB_METRICS_ DB. jdbc:mysql://192.168.52.203:3306/MB_METRICS?autoReconnect=true
CONFIG_PARAM_MB_METRICS_DB_USERNAMEYesUsername of the MB_METRICS_ DB. root
CONFIG_PARAM_MB_METRICS_DB_PASSWORDYesPassword of the MB_METRICS_ DB. root
CONFIG_PARAM_MB_STORE_DB_URLYesURL of the MB_STORE_ DB. 

jdbc:mysql://192.168.52.203:3306/MB_STORE?autoReconnect=true

CONFIG_PARAM_MB_STORE_DB_USER_NAMEYesUsername of the MB_STORE_ DB. root
CONFIG_PARAM_MB_STORE_DB_PASSWORDYesPassword of the MB_STORE_ DB. root
CONFIG_PARAM_MB_STORE_DB_DRIVERYesDriver class name used in the data source.com.mysql.jdbc.Driver

 

CEP cartridge specific payload properties

Property NameClustered
Setup
Standalone
Setup 
DescriptionExample Values
CONFIG_PARAM_PRESENTER_ENABLEYesNoEnable Presenter mode in CEP.true
CONFIG_PARAM_WORKER_ENABLEYesNoEnable Worker mode in CEP.true
Note

There are not cartridge specific payload parameters for the following cartridges:

  • Application Server (AS)
  • Business Process Server (BPS)
  • Business Rules Server (BRS)
  • Governance Registry (GREG)
  • Identity Server (IS)