This document is work in progress and will be released with the 5.4.0 GA release.
The following instructions guide you through upgrading from WSO2 Identity Server 5.3.0 to WSO2 Identity Server 5.4.0. In this topic, <OLD_IS_HOME>
is the directory that Identity Server 5.3.0 resides in and <NEW_IS_HOME>
is the directory that Identity Server 5.4.0 resides in.
Before you begin
- This release is a WUM-only release. This means that there are no manual patches and any further fixes or latest updates for this release can be updated through the WSO2 Update Manager (WUM).
- If you are upgrading to this version to use this version in your production environment, use the WSO2 Update Manager and get the latest available updates for WSO2 IS 5.4.0. For more information on how to do this, see Updating WSO2 Products.
- If you are upgrading to this version only to do an incremental upgrade to the next available version (e.g., if you are upgrading from WSO2 IS 5.3.0 - 5.5.0), you can skip this step and migrate to 5.4.0 by following the steps given in this document. You do not need to use WUM in this instance because the WUM updates available for this version will be included in the WSO2 IS pack of the next version.
- If you are upgrading to this version to use this version in your production environment, use the WSO2 Update Manager and get the latest available updates for WSO2 IS 5.4.0. For more information on how to do this, see Updating WSO2 Products.
If you have added any custom claims, expand the section below and follow the steps before migrating to WSO2 IS 5.3.0.
Migrating the embedded LDAP user store
It is not generally recommended to use the embedded LDAP user store that is shipped with WSO2 Identity Server in production setups. However, if migration of the embedded LDAP is required, follow the instructions below to migrate the existing IS 5.3.0 LDAP user store to IS 5.4.0.
- Copy the
<OLD_IS_HOME>/repository/data
folder to<NEW_IS_HOME>/repository/data
folder. - Restart the server to save the changes.
To upgrade the version of WSO2 Identity Server, the user store database should be upgraded. Note that there are no registry schema changes between versions.
Follow the steps below as needed to complete the migration process.
- Download Identity Server 5.4.0 and unzip it in the
<NEW_IS_HOME>
directory. - Take a backup of the existing database used by Identity Server 5.3.0. This backup is necessary in case the migration causes issues in the existing database.
- Make the database script updates as indicated below.
Download the migration resources and unzip it to a local directory. This folder is referred to as
<IS5.4.0_MIGRATION_TOOL_HOME>
.Copy the db script files in the
<IS5.3.0_MIGRATION_TOOL_HOME>/dbscripts/identity/
directory to the<NEW_IS_HOME>/dbscripts/identity/migration-5.3.0_to_5.4.0/
directory.- Copy the
org.wso2.carbon.is.migrate.client-5.4.0.jar
file in the<IS5.3.0_MIGRATION_TOOL_HOME>/dropins
directory to the<NEW_IS_HOME>/repository/components/dropins
directory. - Alternatively, if you are using Oracle database, you can either provide the database owner credentials in the datasource configurations (identity and user management databases) or pass the identity database owner name with -
DidentityOracleUser
and user management database owner name with -DumOracleUser
.
- 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. 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.Copy the
.jks
files from the<OLD_IS_HOME>/repository/resources/security
folder and paste them in<NEW_IS_HOME>/repository/resources/security
folder.- 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. 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.The ClaimManagementService API is not recommended for use with WSO2 IS 5.3.0. If you are using the ClaimManagementService API and have written any clients using the service, convert the clients to the new and improved ClaimMetaDataManagementService API that is packaged with WSO2 IS 5.3.0.
You can use one of the following approaches to migrate depending on your production evironment.
Migrating by updating the custom configurations
This approach is recommended if:
- You have done no custom changes in your previous version of WSO2 IS.
You have done very few custom changes in your previous version of WSO2 IS. These custom changes have been tracked and are easy to redo.
Steps:- If you have done custom changes to the config files in your previous version of WSO2 IS, update the files in the
<NEW_IS_HOME>/repository/conf
folder with your custom configurations. - Proceed to step 11 to run the migration client.
Migrating by updating the new configurations in 5.3.0
This approach is recommended if:
- You have done many custom changes in your previous version of WSO2 IS.
These custom changes have not been tracked completely and/or are difficult to redo.
Steps:
- Make a copy of the
<OLD_IS_HOME>/repository/conf
folder. (Do not change the original configs. You may use it as a backup in case there are any issues) The table below lists out all the configuration changes from IS 5.3.0 to IS 5.4.0. You can scroll through the table and change the relevant configurations according to the features you are using.
Tip: Scroll left/right to view the entire table below.
Replace the
<NEW_IS_HOME>/repository/conf
folder with the modified copy of the<OLD_IS_HOME>/repository/conf
folder.Start the Identity Server 5.4.0 with the following command to perform the data migration for all components.
See the notes below to perform migration for individual components or for active tenants only.
Linux/Unix:
sh wso2server.sh -Dmigrate -Dcomponent=identity
Windows:
wso2server.bat -Dmigrate -Dcomponent=identity
Migrate individual components
Optional: To migrate certain components only, use the relevant commands in the table below.
Warning! Unless specifically required, it is recommended to perform the full data migration by executing the command given above. Component migration is intended for certain special cases only, and may cause errors due to incomplete migration, if done incorrectly.
Migrate active tenants only
Optional: If you have any disabled/inactive tenants in your previous version of WSO2 IS that you do not want to bring forward to the next version, do a complete migration for all components with active tenants only.
- Once the migration is successful, stop the server and start using the appropriate command.
Linux/Unix:
sh wso2server.sh
Windows:
wso2server.bat