Versions Compared

Key

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

This section guides you through the logical separation of data that you can do when clustering WSO2 Identity Server. 

Tip
titleBefore you begin

Before you begin, note that creating separate databases as shown below is not actually required and can be skipped. Instead, you can point all the datasources given below to a single database. This will NOT make a difference in performance. To do this, see the steps given within the flow of the deployment pattern setup in the Configuring the datasources /wiki/spaces/IS550/pages/29720948 sub topic.

However, if you do want to separate the data logically into separate databases, you can follow the steps given below.

...

Database NameDescriptionScript locationDatasource file to be modified
USERSTORE

WSO2_USER_DB

Authorization manager configurations, internal permissions and roles.
<IS_HOME>/dbscripts/

<IS_HOME>/repository/conf/datasources/master-datasources.xml

Note
The data source name mentioned in the master-datasources.xml file should be included in the user-mgt.xml file in <PRODUCT_HOME>/repository/conf/ as well.
IDENTITY_DBContains identity related data, for example, OAuth 2.0, SAML 2.0, etc.
<IS_HOME>/dbscripts/identity/

<IS_HOME>/repository/conf/datasources/master-datasources.xml

Note
The data source name mentioned in the master-datasources.xml file should be included in the identity.xml file in <PRODUCT_HOME>/repository/conf/identity as well.
METRICS_DBMetrics Database is used to store the runtime metrics data reported by the Metrics JDBC Reporter periodically. There are 5 tables to store metrics data for each metric type. The metric types are Counter, Meter, Gauge, Histogram, and Timer.
<IS_HOME>/dbscripts/metrics/
<IS_HOME>/repository/conf/datasources/metrics-datasources.xml
BPS_DBThis is used to create, drop, and truncate data pertaining to the workflow feature.
  • To create workflow related tables and indexes, use the scripts in the <IS_HOME>/dbscripts/bps/bpel/create directory.
  • To delete workflow related tables, use the scripts in the <IS_HOME>/dbscripts/bps/bpel/drop directory.
  • To remove workflow related data from tables, use the scripts in the <IS_HOME>/dbscripts/bps/bpel/truncate directory.
<IS_HOME>/repository/conf/datasources/bps-datasources.xml
REGISTRY_DBShared database for config and governance registry mounts in the product's nodes. This includes data on tenants and keystores.
<IS_HOME>/dbscripts/
<IS_HOME>/repository/conf/datasources/master-datasources.xml
CONSENT_MGTThis is used for data pertaining to user consents.<IS_HOME>/dbscripts/consent

<IS_HOME>/repository/conf/datasources/master-datasources.xml

Note
The data source name mentioned in the master-datasources.xml file should be included in the consent-mgt-config.xml file in <PRODUCT_HOME>/repository/conf/ as well.

To understand this concept further, see the following diagram.

Image RemovedImage Added

For more information on the concept of sharing governance and config registry databases across the cluster, see the topic on Sharing Databases in a Cluster in the WSO2 Product Administration Guide.

...