This documentation is for WSO2 Governance Registry 5.0.0. View documentation for the latest release.

Versions Compared


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


  1. Download WSO2 Governance Registry 5.0.0

  2. Log in to the WSO2 G-Reg Management Console and create the /_system/governance/trunk/endpoints endpoint collectionendpoints collection. For instructions, see Adding a Collection.


    The endpoints RXT is introduced in WSO2 G-Reg 5.0.0. Therefore, since the migration client might try to migrate data from "/_system/governance/trunk/endpoints", which is not available in WSO2 G-Reg versions below 5.0.0, you need to manually create this endpoint collection before upgrading.

  3. Stop all running server instances of WSO2 Governance Registry 4.6.0.

  4. Make sure that you have taken a backup of all the databases and existing configurations.
  5. Follow the steps below to configure the database (in the master-datasources.xml file) and the datasource property values (in the registry.xml, user-mgt.xml and api-manager.xml files) of the new WSO2 G-Reg version, similar to the previous G-REG version.

    1. Configure <G-REG_5.0.0__HOME>/repository/conf/datasources/master-datasources.xml. For more information on how to do this for your database, see Working with Databases.
    2. Go to the <G-REG_5.0.0__HOME>/repository/conf directory and update the datasource references in user-mgt.xmlregistry.xml and api-manager.xml 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.

      Code Block
      <dbConfig name="wso2registry">
      Code Block
        <Property name="dataSource">jdbc/WSO2CarbonDB</Property>
      Code Block
  6. If there are several 1000s 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_5.0.0__HOME>/repository/conf/registry.xml file as shown below.

    Code Block
    <!--number of resources submit for given indexing thread -->
    <!--number of worker threads for indexing -->
    <!-- location storing the time the indexing took place-->
  7. Download the org.wso2.carbon.greg.migrate.client-5.0.0.jar file and copy it to the <G-REG_5.0.0__HOME>/repository/components/dropins directory. If you use a clustered/distributed setup, copy the JAR file to the master nodes. 
  8. Start the WSO2 Governance Registry 5.0.0 with the following command options to migrate the registry configurations. If you have a clustered/distributed setup, run the following command options in master node only.

    Code Block
    -Dmigrate=5.0.0 -DmigrateReg=true

    For example,

    Linux: sh -Dmigrate=5.0.0 -DmigrateReg=true

    Windows: wso2server.bat -Dmigrate=5.0.0 -DmigrateReg=true

  9. It is recommended to restart all the WSO2 Governance Registry 5.0.0 instances. Check for any other configurations that were done for WSO2 Governance Registry 4.6.0 (based on your solutions), and update the configuration files in WSO2 Governance Registry 5.0.0 accordingly. For example, external user stores, caching, mounting.