This documentation is for WSO2 Enterprise Service Bus version 5.0.0. For the latest ESB, view the latest WSO2 Enterprise Integrator documentation.

All docs This doc
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 25 Next »

This page walks you through the process of upgrading to ESB 5.0.0 from ESB 4.8.1 and ESB 5.0.0. Go to the required tab for step by step instructions based on the upgrade you need to perform.

If you are upgrading from a version older than ESB 4.8.1, first upgrade to ESB 4.8.1 and then upgrade to ESB 5.0.0.

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

You cannot roll back the upgrade process. However, it is possible to restore a backup of the previous database so that you can restart the upgrade progress.

Preparing to upgrade 

The following prerequisites must be completed before upgrading:

Note

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

Upgrading the database

It is not mandatory that you migrate the user management database when upgrading from ESB 4.9.0 to ESB 5.0.0.

If you choose to proceed without migrating,

 Click here to expand...

you can do so by editing the following property in <ESB_5.0.0_HOME>/repository/conf/user-mgt.xml file.

<Property name="isCascadeDeleteEnabled">true</Property>

If you choose to migrate,

 Click here to expand...

Download the  WSO2 Identity Server Migration Client. This used to migrate the user management database schemas that is used by WSO2 ESB. Unzip the downloaded file to a local directory. Unzip the downloaded file to the local file system and you will have a directory named wso2is-5.1.0-migration. Then do the following:

  1. Copy the wso2is-5.1.0-migration/dbscripts/migration­5.0.0_to_5.1.0 directory to the <ESB_5.0.0_HOME>/dbscripts directory. 
  2. Copy the wso2is-5.1.0-migration/ dbscripts/identity/migration­5.0.0SP1_to_5.1.0 directory and the wso2is-5.1.0-migration/dbscripts/identity/migration 5.0.0_to_5.0.0SP1 directory to the <ESB_5.0.0_HOME>/dbscripts/identity directory.
  3. Copy the wso2is-5.1.0-migration/dropins/org.wso2.carbon.is.migrate.client-­5.1.0.jar file to the <ESB_5.0.0_HOME>/repository/components/dropins directory. 
  4. Start WSO2 ESB 5.0.0 with the command line option -Dmigrate -Dcomponent=identity to migrate the user management database.

 

Migrating the configuration files

Note

 Configurations should not be copied directly between servers.

To connect ESB 5.0.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.9.0 based on your solution and update the configuration files in ESB 5.0.0 accordingly. For example, configurations related to external user stores, caching, mounting, transports etc.

    Note

    The following files have changed from ESB 4.9.0 to ESB 5.0.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
  4. If there are any third party libraries used with ESB 4.9.0 that you want to migrate, copy the following directories as applicable from ESB 4.9.0 to ESB 5.0.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

Migrating Artifacts

You should manually deploy Composite Application Archive (CAR) files that you have in ESB 4.9.0 to ESB 5.0.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 Deploying Composite Applications in the Server in the WSO2 Admin Guide for further details.

Note

 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.9.0 to ESB 5.0.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.9.0 to ESB 5.0.0.
  • If multi-tenancy is used, copy the <ESB_HOME>/repository/tenants directory from ESB 4.9.0 to ESB 5.0.0.

Testing the upgrade

Verify that all the required scenarios are working as expected in ESB 5.0.0. This confirms that the upgrade is successful.

This content is being reviewed!

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

You cannot roll back the upgrade process. However, it is possible to restore a backup of the previous database so that you can restart the upgrade progress.

Preparing to upgrade 

The following prerequisites must be completed before upgrading:

Note

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

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 5.0.0.

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

    • You should NOT connect a new version of WSO2 ESB to an older database that has not been upgraded.
    • If you are using MySQL database, you will need to 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 5.0.0. 
  2. Download the  WSO2 Identity Server Migration Client. This used to migrate the user management database schemas that is used by WSO2 ESB. Unzip the downloaded file to a local directory. Unzip the downloaded file to the local file system and you will have a directory named wso2is-5.1.0-migration. Then do the following:

    1. Copy the wso2is-5.1.0-migration/dbscripts/migration­5.0.0_to_5.1.0 directory to the <ESB_5.0.0_HOME>/dbscripts directory. 
    2. Copy the wso2is-5.1.0-migration/dbscripts/identity/migration­5.0.0SP1_to_5.1.0 directory and the wso2is-5.1.0-migration/dbscripts/identity/migration 5.0.0_to_5.0.0SP1 directory to the <ESB_5.0.0_HOME>/dbscripts/identity directory.
    3. Copy the wso2is-5.1.0-migration/dropins/org.wso2.carbon.is.migrate.client-­5.1.0.jar file to the <ESB_5.0.0_HOME>/repository/components/dropins directory.

  3. Start WSO2 ESB 5.0.0 with the command line option -Dmigrate -Dcomponent=identity to migrate the user management database.

Migrating the configuration files

Note

 Configurations should not be copied directly between servers.

To connect ESB 5.0.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 5.0.0 accordingly. For example, configurations related to external user stores, caching, mounting, transports etc.

    Note

    The following files have changed from ESB 4.8.1 to ESB 5.0.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
  4. 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 5.0.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

Migrating Artifacts

You should manually deploy Composite Application Archive (CAR) files that you have in ESB 4.8.1 to ESB 5.0.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 Deploying Composite Applications in the Server in WSO2 Admin Guide for further details.

Note

 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.1 to ESB 5.0.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.1 to ESB 5.0.0.
  • If multi-tenancy is used, copy the <ESB_HOME>/repository/tenants directory from ESB 4.8.1 to ESB 5.0.0.

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 ESB Tooling before you can migrate them to ESB 5.0.0. 

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

 

Testing the upgrade

Verify that all the required scenarios are working as expected in ESB 5.0.0. This confirms that the upgrade is successful.



  • No labels