Page Comparison

 To migrate deployment artifacts including ESB message flow configurations.

• Copy the required synapse artifacts from the <ESB_HOME>/repository/deployment/server directory of ESB 4.8.0 to ESB 4.9.0.  If you do not have axis2 modules or axis2 services, you can copy the required synapse artifacts from the <ESB_HOME>/repository/deployment/server/synapse-configs/default directory of ESB 4.8.0 to ESB 4.9.0.
• If multi-tenancy is used, copy the <ESB_HOME>/repository/tenants directory from ESB 4.8.0 to ESB 4.9.0.

The org.wso2.caching.digest.REQUESTHASHGenerator interface, which is supported by WSO2 ESB 4.8.1 is not supported by later versions. Therefore, change the artifacts to use the org.wso2.carbon.mediator.cache.digest.DOMHASHGenerator as the hash generator when migrating artifacts related to the Cache mediator from WSO2 ESB 4.8.1 to a later version.

Prior to copying the above folders remove all secured services from the folder.

With the removal of QoS features from ESB management console, enabling security for services hosted in ESB has changed from ESB 4.9.0 onwards. You now need to secure your services using WSO2 Developer Studio before you can migrate them to ESB 4.9.0.

See, Applying Security to a Proxy Service for instructions on how to create secured services and deploy them in ESB.

The followings steps describe how you can upgrade data and configurations from ESB 4.8.

1 to ESB 4.9.0.

Testing the upgrade

1. When the database upgrade scripts are executed, the following are some of the new tables that will be created in the database:
   • UM_DOMAIN
   • UM_SYSTEM_USER
   • UM_SYSTEM_ROLE
   • UM_SYSTEM_USER_ROLE
2. Verify that all the required scenarios are working as expected. This confirms that the upgrade is successful.

The followings steps describe how you can upgrade data and configurations from ESB 4.8.1 to ESB 4.9.0. For more information on release versions, see the Release Matrix.

Preparing to upgrade 

The following prerequisites must be completed before upgrading:

• Make a backup of the ESB 4.8.1 database and copy the <ESB_HOME_4.8.1> directory in order to backup the product configurations.
• Download ESB 4.9.0 from http://wso2.com/products/enterprise-service-bus/.

Upgrading the database

The instructions in this section describe how you can perform a data migration to upgrade the 4.8.1 database for use in ESB 4.9.0.

1. Before you upgrade to ESB 4.9.0, create a new database and restore the backup of the ESB 4.8.1 database in this new database.

   Info
   title Note
   You should NOT connect a new version of WSO2 ESB to an older database that has not been upgraded.

2. Select the mysql.sql script for the upgrade from here and run it on the new database. Running this script will ensure that the new database is upgraded to have the additional tables and schemas that are required for ESB 4.9.0. 

Once you run the migration scripts on the new database, it becomes the upgraded database for ESB 4.9.0.

Migrating the configurations

Once you have completed the database upgrade, You can proceed with the configuration changes as explained below. The configurations can be directly migrated  For more information on release versions, see the Release Matrix.

Preparing to upgrade 

The following prerequisites must be completed before upgrading:

• Make a backup of the ESB 4.8.1 database and copy the <ESB_HOME_4.8.1> directory in order to backup the product configurations.
• Download ESB 4.9.0 from http://wso2.com/products/enterprise-service-bus/.

Upgrading the database

The instructions in this section describe how you can perform a data migration to upgrade the 4.8.1 database for use in ESB 4.9.0.

1. Before you upgrade to ESB 4.9.0, create a new database and restore the backup of the ESB 4.8.1 database in this new database.

   Info
   title Note
   You should NOT connect a new version of WSO2 ESB to an older database that has not been upgraded.

2. Select the mysql.sql script for the upgrade from here and run it on the new database. Running this script will ensure that the new database is upgraded to have the additional tables and schemas that are required for ESB 4.9.0. 

Once you run the migration scripts on the new database, it becomes the upgraded database for ESB 4.9.0.

Migrating the configurations

Once you have completed the database upgrade, You can proceed with the configuration changes as explained below. The configurations can be directly migrated from ESB 4.8.1 to ESB 4.9.0.

To connect ESB 4.9.0 to the upgraded database, configure the following files:

1. Go to the <ESB_HOME>/repository/conf/datasources directory and update the master-datasources.xml file . See Configuring master-datasources.xml.

2. Go to the <ESB_HOME>/repository/conf directory and update the datasource references in the user-mgt.xml and registry.xml files to match the updated configurations in the  master-datasources.xml file that you made in the above step. See Configuring user-mgt.xml and Configuring registry.xml.

3. Check for any other configurations that were done for ESB 4.8.1 based on your solution and update the configuration files in ESB 4.9.0 accordingly. For example, configurations related to external user stores, caching, mounting, transports etc.

4. Go to the <ESB_HOME>/repository/conf/datasources directory and update the master-datasources.xml file . See Configuring master-datasources.xml.

5. Go to the <ESB_HOME>/repository/conf directory and update the datasource references in the user-mgt.xml and registry.xml files to match the updated configurations in the  master-datasources.xml file that you made in the above step. See Configuring user-mgt.xml and Configuring registry.xml.

6. Check for any other configurations that were done for ESB 4.8.1 based on your solution and update the configuration files in ESB 4.9.0 accordingly. For example, configurations related to external user stores, caching, mounting, transports etc.

   Info
   title Note
   The following files have changed from ESB 4.8.1 to ESB 4.9.0 axis2.xml axis2_nhttp.xml axis2_pt.xml tenant-axis2.xml cache.xml config-validation.xml logging-bridge.properties osgi-debug.option cloud-services-desc.xml authenticators.xml ciper-tool.properties catalina-server.xml carbon.xml identity.xml nhttp.properties passthru-http.properties synapse.properties user-mgt.xml

7. If there are any third party libraries used with ESB 4.8.1 that you want to migrate, copy the following directories as applicable from

   Info
   title Note
   The following files have changed from ESB 4.8.1 to ESB 4.9.0 axis2.xml

To connect ESB 4.9.0 to the upgraded database, configure the following files:

1. axis2_nhttp.xml axis2_pt.xml tenant-axis2.xml cache.xml config-validation.xml logging-bridge.properties osgi-debug.option cloud-services-desc.xml authenticators.xml ciper-tool.properties catalina-server.xml carbon.xml identity.xml nhttp.properties passthru-http.properties synapse.properties user-mgt.xml

2. If there are any third party libraries used with ESB 4.8.1 that you want to migrate, copy the following directories as applicable from ESB 4.8.1 to ESB 4.9.0:
   
   • If you have used JMS libraries, JDBC libraries etc, copy <ESB_HOME>/repository/components/lib
   • If you have used OSGi bundles such as SVN kit etc, copy <ESB_HOME>/repository/components/dropins
3. Start the ESB 4.9.0 server.

Migrating artifacts

You should manually deploy Composite Application Archive (CAR) files that you have in ESB 4.8.1 to ESB 4.9.0. If you have a mediator packed in a CAR, all the artifacts using that mediator should also be included in the same CAR. See Creating and Deploying a Carbon Application for further details.

Migrating artifacts

You should manually deploy Composite Application Archive (CAR) files that you have in ESB 4.8.1 to ESB 4.9.0. If you have a mediator packed in a CAR, all the artifacts using that mediator should also be included in the same CAR. See Creating and Deploying a Carbon Application for further details.

Testing the upgrade

1. When the database upgrade scripts are executed, following are some of the new tables that will be created in the database:
   • UM_DOMAIN
   • UM_SYSTEM_USER
   • UM_SYSTEM_ROLE
   • UM_SYSTEM_USER_ROLE
2. Verify that all the required scenarios are working as expected. This confirms that the upgrade is successful.