This documentation is for WSO2 Identity Server 5.7.0 . View documentation for the latest release.

All docs This doc

Versions Compared

Key

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

...

  1. Take a backup of the existing database used by the <OLD_IS>. This backup is necessary in case the migration causes issues in the existing database.
    Make the following database updates as indicated below.
    1. Download the migration resources and unzip wso2is-migration-x.x.x.zip file from the latest release tag of the migration resources. Unzip it to a local directory.
      This folder is referred to as <IS5.x.x<IS_MIGRATION_TOOL_HOME>.

    2. Copy the org.wso2.carbon.is.migration-1x.x.x.jar and the snakeyaml-1.16.0.wso2v1.jar found in the <IS5.7.0 file in the <IS_MIGRATION_TOOL_HOME>/dropins directory, and paste it in the  folder into the <NEW_IS_HOME>/repository/components/dropins directory. 

    3. Copy migration-resources folder to the <NEW_IS_HOME> root folder. 

    4. Set the following property values accordingly in the migration-config.yaml file found in the <NEW_IS_HOME>/migration-resources folder. Specify the current WSO2 Identity Server version as the currentVersion value and specify the new version of WSO2 Identity Server that you want to migrate to, as the  migrateVersion

      Tip

      If your current version of WSO2 Identity Server is 5.4.1, set the value of the currentVersion parameter to 5.4.0 in the migration-config.yaml instead. This is because data migration is not required when migrating from 5.4.0 to 5.4.1.

      Code Block
      migrationEnable: "true"
      
      currentVersion: "5.x.x"
      
      migrateVersion: "5.x.x"
  2. Copy any custom OSGI bundles that were added manually from the <OLD_IS_HOME>/repository/components/dropins folder and paste it in the <NEW_IS_HOME>/repository/components/dropins folder. 
  3. Copy any added JAR files from the <OLD_IS_HOME>/repository/components/lib folder and paste it in the <NEW_IS_HOME>/repository/components/lib folder. 

  4. Copy the .jks files from the <OLD_IS_HOME>/repository/resources/security folder and paste them in <NEW_IS_HOME>/repository/resources/security folder. 

  5. If you have created tenants in the previous WSO2 Identity Server version and if there are any resources in the <OLD_IS_HOME>/repository/tenants directory, copy the content to the <NEW_IS_HOME>/repository/tenants directory.
  6. If you have created secondary user stores in the previous WSO2 IS version, copy the content in the <OLD_IS_HOME>/repository/deployment/server/userstores directory to the <NEW_IS_HOME>/repository/deployment/server/userstores directory.

    Tip

    Note: If your current version is 5.0.0, run the following queries on the database that is referenced in the identity.xml file in order to identify if there is any corrupted data.


    Code Block
    SELECT * FROM IDN_OAUTH2_ACCESS_TOKEN WHERE AUTHZ_USER LIKE '% @%' AND TOKEN_STATE='ACTIVE';
    SELECT * FROM IDN_OAUTH2_ACCESS_TOKEN WHERE AUTHZ_USER NOT LIKE '%@%' AND TOKEN_STATE='ACTIVE';
  7. Start WSO2 Identity Server with the following command to perform the data migration for all components. 

    1. Linux/Unix:

      Code Block
      languagebash
      sh wso2server.sh -Dmigrate -Dcomponent=identity
    2. Windows:

      Code Block
      languagebash
      wso2server.bat -Dmigrate -Dcomponent=identity
  8. Once the migration is successful, stop the server and remove the following files and folders  from the  <NEW_IS_HOME>/repository/components/dropins  directory.

    1.   org.wso2.carbon.is.migration-5.7.0.jar

    2. snakeyaml-1.16.0.wso2v1.jar  

    3. migration-resources directory