This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Payload Property Definitions Cartridge - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

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

General payload property definitions

Property NameClustered SetupStandalone
Setup 
DescriptionExample Values
ManagerWorker
COMMIT_ENABLEDYesNoNoThis 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_CLUSTERINGYesYesYesTo enable clustering in WSO2 Productstrue - for a clustered setup
false - for a standalone setup 
CONFIG_PARAM_LB_IP, LB_IP
YesYesNoDefines the load balancer IP which is fronted by the cartridge.127.0.0.1
CONFIG_PARAM_REGISTRY_DB_URL,
CONFIG_PARAM_REG_DB_URL 
YesYesNoURL of registry databasejdbc:mysql://172.17.8.1:3306/registry_44x
CONFIG_PARAM_REGISTRY_DB_USER_NAMEYesYesNoUsername of registry databaseroot
CONFIG_PARAM_REGISTRY_DB_PASSWORDYesYesNoPassword of registry databaseroot
CONFIG_PARAM_REGISTRY_DB_DRIVERYesYesNoDriver class name used in data sourcecom.mysql.jdbc.Driver
CONFIG_PARAM_CONFIG_DB_URLYesYesNoURL of config databasejdbc:mysql://172.17.8.1:3306/config_db_as_530
CONFIG_PARAM_CONFIG_DB_USER_NAMEYesYesNoUsername of config databaseroot
CONFIG_PARAM_CONFIG_DB_PASSWORDYesYesNoPassword of config databaseroot
CONFIG_PARAM_CONFIG_DB_DRIVERYesYesNoDriver class name used in data source
com.mysql.jdbc.Driver
CONFIG_PARAM_USER_MGT_DB_URL, CONFIG_PARAM_UM_DB_URL YesYesNoURL of user Management databasejdbc:mysql://172.17.8.1:3306/userstore_44x
CONFIG_PARAM_USER_MGT_DB_USER_NAMEYesYesNoUsername of user Management databaseroot
CONFIG_PARAM_USER_MGT_DB_PASSWORDYesYesNoPassword of user Management databaseroot
CONFIG_PARAM_USER_MGT_DB_DRIVERYesYesNoDriver 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.

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 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_URLYesYesYesURL of API_Mgt related databasejdbc:mysql://172.17.42.1:3306/apimgtdb
CONFIG_PARAM_APIMGT_DB_USER_NAMENoNoYesUsername of API_Mgt databaseroot
CONFIG_PARAM_APIMGT_DB_PASSWORDNoNoYesPassword of API_Mgt databaseroot
CONFIG_PARAM_KEYVALIDATORCLIENTTYPE
YesYesNoKey validator client type used in API ManagerWSClient
CONFIG_PARAM_DOMAINYesYesNoDomain name to be used in the deploymentwso2.pub.store.domain

DAS cartridge specific payload properties 

Property NameDescriptionExample Values
CONFIG_PARAM_MEMBERSHIP_SCHEMEMembership 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.


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

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 class name used in data sourcecom.mysql.jdbc.Driver
CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_URLURL of the WSO2_ANALYTICS_EVENT_STORE. 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_NAMEUsername of the WSO2_ANALYTICS_EVENT_STOREroot
CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_PASSWORDPassword of the WSO2_ANALYTICS_EVENT_STOREroot
CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_DRIVERDriver class name used in data sourcecom.mysql.jdbc.Driver
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_URLURL of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB. This is used for managing processed data.jdbc:mysql://192.168.52.203:3306/ANALYTICS_PROCESSED_DATA_STORE?autoReconnect=true
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_USER_NAMEUsername of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB. root
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_PASSWORDPassword of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB. root
CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_DRIVERDriver class name used in 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 data sourcecom.mysql.jdbc.Driver

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)
 
  • No labels