Changing the Default RSS Configuration

Introduction

In order to use the RDBMS provisioning facility offered by WSO2 Storage Server, as the first step, you need to configure RDBMS servers using a configuration file. This includes setting up RSS metadate repository that is used to maintain user-created databases, database users and privilege templates. By default, the RSS metadata repository is pointed to an embedded H2 database that is shipped as part of the WSO2 Storage Server installation archive.

In a typical production setting, we recommend you to use an enterprise-grade RDBMS such as MySQL , SQL SERVER or Oracle as the RSS metadata repository. You can do this in 3 steps as follows:

1. Create a database as the RSS metadata repository and a database user with admin privileges equivalent to the dba role. (this grants access to the database used as the RSS metadata repository). 

   Please note that this database should be created in a database server which is of the same RDBMS type you are going to provision.   

2. Select the SQL script appropriate to the RDBMS you have from <SS_HOME>/dbscripts directory and run it. This creates the RSS metadata repository database structure. For example, if your RDBMS is MySQL, the script you must run is <SS_HOME>/dbscripts /rss-manager/mysql/wso2_rss_mysql.sql.
   
3. Add the required JDBC drivers for the database you selected to <SS_HOME>/repository/components/lib.
4. Edit the parameters required to connect to the RSS metadata repository database as well as the database servers to be provisioned as explained below. 

Sample configuration

Following sample configuration shows how to change the default RSS configuration in WSO2 Storage Server.  It uses a database named rss_db as the RSS metadata repository, which is used to store metadata pertaining to databases, database users, database privilege templates, etc.

It also defines RSS provisioning environments that can be considered as a logical boundary separating a database server instance cluster from another. One typical example of using multiple provisioning environment is that, if you are running an application development infrastructure allowing users to develop applications in different environments within its life cycle, such as DEV, QA, STAGING, PROD, etc., you would ideally need to have separate database provider infrastructure per environment. The aforementioned feature can be a handful in provisioning all those environments with a single WSO2 Storage Server instance.

Follow the instructions below to configure RSS metadata repository and database instances you want to use for database provisioning. 

1. Create a DataSource in the <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file and point to that from the <PRODUCT_HOME>/repository/conf/etc/rss-config.xml file using its JNDI name.
   
   Do the following configuration changes in the  <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file. (In this example, our metadata repository database name is “rss_db”. )
   

   The elements of the sample configuration are explained below. You can use this information to edit the file according to your requirements. For more information please see configuring master datasources.

   Property Name		Description	Type	Default Value	Fixed Values	Mandatory/Optional
   <dataSourceClassName>		This is the XA Driver Class provided by the JDBC driver used to connect to the type of RDBMS in which the RSS metadata repository is configured. E.g., if RSS metadata repository database is configured on MySQL - "com.mysql.jdbc.jdbc2.optional.MysqlXADataSource" has to be used as the value of this particular attribute.				Mandatory
   <dataSourceProps>		Root element of the XA data source property collection that needs to be configured in order to initialize the XA datasource driver used in the RSS metadata repository configuration.		-	-	Mandatory
   <property name="property_name">+		Element used to specify bean properties of the XA datasource driver used in RSS metadata repository configuration. (Note: The set of properties that are to be configured are different based on the XA driver class used). E.g., the sample configuration which can be used to populate the bean properties required for MySQL XA driver is as follows: <dataSourceProps> <property name = "URL">xxxx</property> <property name = "user">xxxx</property> <property name = "password">xxxx</property> </dataSourceProps>		-	-	Mandatory

   The rss-config.xml file is located in <PRODUCT_HOME>/repository/conf/etc/rss-config.xml file.

   <ManagementRepository>
   	    <DataSourceConfiguration>
   			<JndiLookupDefinition>
   		     	<Name>MetadataRepoDS</Name>
   			</JndiLookupDefinition>
   	    </DataSourceConfiguration>
   </ManagementRepository>

   Please note that JNDI name of both config files should be the same. In this example, it is "MetadataRepoDS".

    

2. Change following properties in <PRODUCT_HOME>/repository/conf/etc/persistence.xml.
   

3. Configure the RSS Environment by using the following configuration in the rss-config.xml file.

The elements of the sample configuration are explained below. You can use this information to edit the file according to your requirements.

XML elements of the sample configuration