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

Versions Compared

Key

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

...

Property NameClustered SetupStandalone
Setup 
DescriptionExample Values
ManagerWorker
COMMIT_ENABLEDYesNoNo This enables auto commit in Python Cartridge Agent (PCA). Once you give a git repository when creating an application or when signing up, PCA will commit the changes.true
CONFIG_PARAM_CLUSTERINGYesYesYes To enable clustering in WSO2 Productstrue - for a clustered setup
false - for a standalone setup 
CONFIG_PARAM_LB_IP, LB_IP
YesYesNo Defines the load balancer IP which is fronted by the cartridge.127.0.0.1
CONFIG_PARAM_REGISTRY_DB_URL,
CONFIG_PARAM_REG_DB_URL 
YesYesNo Registry database urljdbc:mysql://172.17.8.1:3306/registry_44x
CONFIG_PARAM_REGISTRY_DB_USER_NAMEYesYesNo Registry database usernameroot
CONFIG_PARAM_REGISTRY_DB_PASSWORDYesYesNo Registry database passwordroot
CONFIG_PARAM_REGISTRY_DB_DRIVERYesYesNo Driver class name used in data sourcecom.mysql.jdbc.Driver
CONFIG_PARAM_CONFIG_DB_URLYesYesNo Config database urljdbc:mysql://172.17.8.1:3306/config_db_as_530
CONFIG_PARAM_CONFIG_DB_USER_NAMEYesYesNo Config database usernameroot
CONFIG_PARAM_CONFIG_DB_PASSWORDYesYesNo Config database passwordroot
CONFIG_PARAM_CONFIG_DB_DRIVERYesYesNo Driver class name used in data source
com.mysql.jdbc.Driver
CONFIG_PARAM_USER_MGT_DB_URL,
CONFIG_PARAM_UM_DB_URL
YesYesNo User Management database urljdbc:mysql://172.17.8.1:3306/userstore_44x
CONFIG_PARAM_USER_MGT_DB_USER_NAMEYesYesNo User Management database usernameroot
CONFIG_PARAM_USER_MGT_DB_PASSWORDYesYesNo User Management database passwordroot
CONFIG_PARAM_USER_MGT_DB_DRIVERYesYesNo Driver class name used in data sourcecom.mysql.jdbc.Driver
CONFIG_PARAM_PROFILEYesYesYes

Defines the profile name used in WSO2 product. Based on the 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

 

stratos

Membership scheme name used for cluster discovery

private-paas, wka
CONFIG_PARAM_WORKER_HOST_NAMENoNoYes

 Host name of the worker node or default node

as.wso2.com
APPLICATION_PATHNoNoYes

 Application path which is used to clone the git artifacts.

/var/www

 

AM specific payload properties

Property NameClustered SetupStandalone
Setup 
DescriptionExample Values
ManagerWorker
CONFIG_PARAM_APIMGT_DB_URLYesYesYes API_Mgt related database url 
CONFIG_PARAM_APIMGT_DB_USER_NAMENoNoYes API_Mgt database usernameroot
CONFIG_PARAM_APIMGT_DB_PASSWORDNoNoYes API_Mgt database passwordroot
CONFIG_PARAM_KEYVALIDATORCLIENTTYPE
YesYesNo Key validator client type used in API ManagerWSClient
CONFIG_PARAM_DOMAINYesYesNo Domain name to be used in the deployment 

DAS cartridge specific payload properties 

Property NameDescriptionExample Values
CONFIG_PARAM_MEMBERSHIP_SCHEME Membership scheme name used for cluster discoveryprivate-paas
CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_URLURL of the WSO2_ANALYTICS_FS DB. This is used for file system. 
CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_USER_NAMEUsername of WSO2_ANALYTICS_FS DB.root
CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_PASSWORDPassword of WSO2_ANALYTICS_FS DB.root
CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_DRIVERDriver of Username of WSO2_ANALYTICS_FS DB.class name used in data sourcecom.mysql.jdbc.Driver
CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_URL URL of the WSO2_ANALYTICS_EVENT_STORE. This is used for event store. 
CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_USER_NAME Username of the WSO2_ANALYTICS_EVENT_STOREroot
CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_PASSWORD Password of the WSO2_ANALYTICS_EVENT_STOREroot
CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_DRIVER Driver class name used in data sourcecom.mysql.jdbc.Driver
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_URL URL of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB. This is used for managing processed data. 
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_USER_NAME Username of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB. root
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_PASSWORD Password of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB. root
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_DRIVER Driver class name used in data sourcecom.mysql.jdbc.Driver

MB cartridge specific payload properties

Property NameStandalone
Setup 
DescriptionExample Values
CONFIG_PARAM_MB_METRICS_DB_URLYes URL of the MB_METRICS_DB. 
CONFIG_PARAM_MB_METRICS_DB_USERNAMEYes Username of the MB_METRICS_DB. 
CONFIG_PARAM_MB_METRICS_DB_PASSWORDYes Password of the MB_METRICS_DB. 
CONFIG_PARAM_MB_STORE_DB_URLYes URL of the MB_STORE_DB. 
CONFIG_PARAM_MB_STORE_DB_USER_NAMEYes Username of the MB_STORE_DB. 
CONFIG_PARAM_MB_STORE_DB_PASSWORDYes Password of the MB_STORE_DB. 
CONFIG_PARAM_MB_STORE_DB_DRIVERYes Driver class name used in data source 
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)