In an enterprise system, there will be multiple environments (such as Development, QA, Production etc.) consisting of multiple database server instances (RSS instances). The information about the separate environments and the RSS instances contained in each environment can be defined in the rss-config.xml file stored in the <SS_HOME>/repository/conf/etc/ folder as explained here. Alternatively, once you have already defined a particular environment in the rss-config.xml file, you can add RSS instances to that environment using the management console of WSO2 SS as explained below.
There are two types of RSS instances:
- SYSTEM: Only the Super Tenant (System Administrator) is allowed to create RSS instances of this type.
USER_DEFINED: Any tenant can create RSS instances of this type, provided that the required authority is granted to the user.
Tenant-specific RSS instances:
As a log in user, you need to be assigned to a role that is granted permission to create RSS instances in a particular environment. See more information about creating roles and granting permissions. Thereby, the possibility to define role-based permissions allow tenants to create and maintain separate RSS instances in the environments.
To create an RSS instance:
Note that all RSS instances in all the environments in your system, as well as the database used as the metadata repository should be of the same RDBMS type.
- Start WSO2 Storage Server and log in to the management console.
- Click RSS Instances under RSS Manager in the Main menu.
- Click Add Server Instance and the following screen will open:
- Enter values in the relevant fields to define the RSS instance using the following descriptions:
- RSS Instance Name: Give a name for the database server instance.
- Environment: Select the environment in which the RSS instance should be created. Environments are defined in the rss-config.xml file as explained here.
- Instance Type: If you are logged in as the super tenant (admin user), you can select whether to create an RSS instance of type SYSTEM or USER_DEFINED. However, if you are not the super tenant, USER_DEFINED should be selected for this option.
- Type: Specify the type of database instance. For example, H2, MySQL, Oracle etc.
- JDBC URL: The connection URL to pass to the JDBC driver to establish the connection.
- Datasource Class Name: The class name of the JDBC driver to use.
- Administrative Username: The user name that is used to access the database.
- Administrative Password: The password used to access the database.
In the section on Snapshot Related Information, enter the details of where the database server instance is hosted as shown below. You can use this information to make snapshots of databases created within the RSS instance at a given time.
Note that snapshot creation cannot be used for database instances of "Postgre" type.
- SSH Host: The IP or host name of the location where the database server instance is hosted.
- SSH Port: The port ID.
- SSH Username: The user name required to log in to the host.
- Snapshot Target Directory: The location of the database server instance in the hosting machine.