Skip to end of metadata
Go to start of metadata

This topic provides instructions on how you can upgrade from WSO2 G-Reg 5.3.0 to WSO2 G-Reg 5.4.0.

There are no Registry schema changes between versions. 

If you want to migrate your Governance Registry configurations from one instance to another (such as when promoting your instance from test to production) using the same Governance Registry release, see Migrating the Governance Registry.

Upgrading from an older version

To upgrade from a version older than WSO2 G-Reg 5.3.0, start from the doc that was released immediately after your current release and upgrade incrementally.

Preparing to upgrade

The following are the specific prerequisites you must complete before you upgrade WSO2 G-Reg:

  • Stop all the WSO2 products that are connected to the database.
  • Copy the <G-REG_HOME_5.3.0> directory in order to backup the product configurations.

  • Make a backup of any mounted databases of WSO2 G-Reg 5.3.0.


The following are the limitations of upgrading.

  • This upgrading process can only be done for the same database types. For example, if you are using MySQL currently and you wish to use Oracle in the new version of G-Reg, these scripts will not work.
  • You cannot roll back the upgrading process. However, it is possible to restore a backup of the previous database and redo the upgrading progress.


The downtime is limited to the time taken for switching databases when in the production environment.

Updating the database

Follow the steps below to update the WSO2 G-Reg database.

  1. Download WSO2 Governance Registry 5.4.0

  2. Stop all running server instances of WSO2 Governance Registry 5.3.0.

  3. Make sure that you have taken a backup of all the databases and existing configurations.
  4. To connect the new product version, to the database of the previous version, configure the following files:  
    1. Configure <G-REG_HOME>/repository/conf/datasources/master-datasources.xml. For more information on how to do this for your database, see Changing the default database
    2. Navigate to the <G-REG_HOME>/repository/conf directory, and update the datasource references in user-mgt.xmlregistry.xml and api-manager.xml files, to match the updated configurations in the master-datasources.xml file, which you made in the above step. The following are sample configurations if the datasource is jdbc/WSO2CarbonDB.

      <dbConfig name="wso2registry">
        <Property name="dataSource">jdbc/WSO2CarbonDB</Property>
  5. Follow the below steps to update the database scripts.

    1. Download the migration resources and unzip it to a local directory. This folder is referred to as <MIGRATION_TOOL_HOME>.

      If you are using MySQL 5.7, rename the <MIGRATION_TOOL_HOME>/dbscripts/identity/migration-5.2.0_to_5.3.0/mysql.sql file to mysql_56.sql.

    2. Copy the DB script files in the <MIGRATION_TOOL_HOME>/dbscripts/identity/migration-5.2.0_to_5.3.0 directory to the <G-REG_5.4.0_HOME>/dbscripts/identity/ directory.

    3. Copy the <MIGRATION_TOOL_HOME>/dropins/org.wso2.carbon.is.migrate.client-5.3.0.jar file to the <G-REG_5.4.0_HOME>/components/dropins/ directory.

      Alternatively, if you are using Oracle, either provide the database owner credentials in the datasource configurations (identity and user management databases). Else, pass the identity database owner name with the -DidentityOracleUser command and user management database owner name with ­the -DumOracleUser command.

  6. If there are thousands of artifacts in the system, increase the value of the <indexingFrequencyInSeconds> property (e.g. to 10), or reduce the value of the <batchSize> property (e.g. to 10) in the <G-REG_HOME>/repository/conf/registry.xml file as shown below.

    <!--number of resources submit for given indexing thread -->
    <!--number of worker threads for indexing -->
    <!-- location storing the time the indexing took place-->
  7. Once you are done with the migration tasks, restart the server as follows:

    Execute both commands one after the other.

    For Linux: 

    • sh wso2server.sh -Dmigrate -Dcomponent=identity -DmigratePermissionData
    • sh wso2server.sh -Dmigrate -Dcomponent=identity -DmigrateIdentityDB

    For Windows: 

    • wso2server.bat -Dmigrate -Dcomponent=identity -DmigrateIdentityDB
    • wso2server.bat -Dmigrate -Dcomponent=identity -DmigratePermissionData

Re-indexing resources

Follow the steps below to re-index the resources after completing the migration.

  1. Delete the <G-REG_HOME>/solr/ directory.
  2. Change the name  (e.g.  lastaccesstime to lastaccesstime_1 of the file  in the registry which tracks the last access time of indexing the resources, by changing the value of the  <lastAccessTimeLocation>  property in the  <G-REG_HOME>/repositiry/conf/registry.xml  file as follows.
  3. Restart the G-Reg server and wait for around 30 minutes. This time duration depends on number of resources that are there in the registry.

Going into production

The following are recommended tests to run on the upgraded system. 

  • Create multiple user stores and try adding users to different user stores.

  • Create multiple tenants and add different user stores to the different tenants. Thereafter, add users to the various user stores. 

Once the above tests are run successfully, it is safe to consider that the upgrade is ready for production. However, it is advised to test any features that are being used in production.

  • No labels