WSO2 Complex Event Processor is succeeded by WSO2 Stream Processor. To view the latest documentation for WSO2 SP, see WSO2 Stream Processor Documentation.
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 3 Next »

This section provides information on how you can upgrade from an older version of CEP to a newer version. 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 should be completed  before upgrading.

Upgrading the databases

The instructions in this section describe how you can perform a data migration to upgrade the 4.1.0 database for use in CEP 4.2.0.

  1. Before you upgrade to CEP 4.2.0, create a new database and restore the backup of the CEP 4.1.0 database in this new database.

    You should NOT connect a new version of WSO2 CEP to an older database that has not been upgraded.

  2. Select the relevant 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 CEP 4.2.0.

    There are three migration scripts available:  migration-service-provider.sql , migration-identity.sql and  migration.sql. However, only the  migration.sql script is required to be executed for the CEP database upgrade.

Migrating configurations

Follow the procedure below to migrate configurations from CEP 4.1.0 to CEP 4.2.0.

Configurations should not be copied directly from CEP 4.1.0 to CEP 4.2.0 because some of th configuration files were updated with new properties between the two releases.

  1. Check the configurations in the following files in <CEP_HOME>/repository/conf/data-bridge directory for CEP 4.1.0, and apply the same changes in CEP 4.2.0.
    • data-agent-config.xml
    • data-bridge-config.xml
  2. Check the configurations in the following files in CEP 4.1.0, and apply same configurations in CEP 4.2.0. 

    Configuration FileLocation
    axis2.xml<CEP_HOME>/repository/conf/axis2
    axis2_client.xml<CEP_HOME>/repository/conf/axis2
    carbon.xml<CEP_HOME>/repository/conf
    master-datasources.xml<CEP_HOME>/repository/conf/datasources
    identity.xml<CEP_HOME>/repository/conf
    log4j.properties<CEP_HOME>/repository/conf
    registry.xml<CEP_HOME>/repository/conf
    catalina-server.xml<CEP_HOME>/repository/conf/tomcat
    web.xml<CEP_HOME>/repository/conf/tomcat
  3. If the Cipher tool was configured for CEP 4.1.0, check the configurations in the following files and apply the same changes in CEP 4.2.0.

    Configuration FileLocation
    cipher-text.properties<CEP_HOME>/repository/conf/security
    cipher-tool.properties<CEP_HOME>/repository/conf/security
  4. Check the configurations in the other files located in the <CEP 4.1.0_HOME>/repository/conf directory and apply the same changes to CEP 4.2.0.
  5. If there are any third party libraries used with CEP 4.1.0 that you want to migrate, copy the following directories as applicable from CEP 4.1.0 to CEP 4.2.0.
    • If you have used JMS libraries, JDBC libraries etc, copy <CEP_HOME>/repository/components/lib.
    • If you have used OSGi bundles such as SVN kit etc, copy <CEP_HOME>/repository/components/dropins.
  6. Start the CEP 4.2.0 server. For more information, see Running the Product.

Migrating artifacts

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 should be completed  before upgrading.

Upgrading the databases

The instructions in this section describe how you can perform a data migration to upgrade the 4.0.0 database for use in CEP 4.1.0.

  1. Before you upgrade to CEP 4.1.0, create a new database and restore the backup of the CEP 4.0.0 database in this new database.

    Note

    You should NOT connect a new version of WSO2 CEP to an older database that has not been upgraded.

  2. Select the relevant 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 CEP 4.1.0.

    Note

    There are three migration scripts available:  migration-service-provider.sql , migration-identity.sql and  migration.sql. However, only the  migration.sql script is required to be executed for the CEP database upgrade.

Migrating configurations

Follow the procedure below to migrate configurations from CEP 4.0.0 to CEP 4.1.0.

Configurations should not be copied directly from CEP 4.0.0 to CEP 4.1.0 because the configuration files have new properties added to them as well as obsolete properties removed from them between the two releases.

  1. Check the configurations in the following files in <CEP_HOME>/repository/conf/data-bridge directory for CEP 4.0.0, and apply the same changes in CEP 4.1.0 manually.
    • data-agent-config.xml
    • data-bridge-config.xml
  2. Check the configurations in the following files in CEP 4.0.0, and apply same configurations in CEP 4.1.0 manually. 

    Configuration FileLocation
    axis2.xml<CEP_HOME>/repository/conf/axis2
    axis2_client.xml<CEP_HOME>/repository/conf/axis2
    carbon.xml<CEP_HOME>/repository/conf
    master-datasources.xml<CEP_HOME>/repository/conf/datasources
    identity.xml<CEP_HOME>/repository/conf
    log4j.properties<CEP_HOME>/repository/conf
    registry.xml<CEP_HOME>/repository/conf
    catalina-server.xml<CEP_HOME>/repository/conf/tomcat
    web.xml<CEP_HOME>/repository/conf/tomcat
  3. If the Cipher tool was configured for CEP 4.0.0, check the configurations in the following files and apply the same changes in CEP 4.1.0 manually.

    Configuration FileLocation
    cipher-text.properties<CEP_HOME>/repository/conf/security
    cipher-tool.properties<CEP_HOME>/repository/conf/security
  4. Check the configurations in the other files located in the <CEP 4.0.0_HOME>/repository/conf directory and apply the same changes to CEP 4.1.0 manually.
  5. If there are any third party libraries used with CEP 4.0.0 that you want to migrate, copy the following directories as applicable from CEP 4.0.0 to CEP 4.1.0: 
    • If you have used JMS libraries, JDBC libraries etc, copy <CEP_HOME>/repository/components/lib.
    • If you have used OSGi bundles such as SVN kit etc, copy <CEP_HOME>/repository/components/dropins.
  6. Start the CEP 4.1.0 server. For more information, see Running the Product.

Migrating artifacts

You should manually deploy Composite Application Archive (CAR) files that you have in CEP 4.0.0 to CEP 4.1.0. For more information, see Packaging Artifacts as C-App Archive.

Note

 To migrate deployment artifacts:

  • Copy the <CEP_HOME>/repository/deployment/server directory from CEP 4.0.0 to CEP 4.1.0.
  • If multi-tenancy is used, copy the <CEP_HOME>/repository/tenants directory from CEP 4.0.0 to CEP 4.1.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.

WSO2 CEP 4.0.0 is not backward compatible

Artifacts of CEP 4.0.0 are not backward comparable as there were major changes in the CEP architecture. Therefore, they need to be rewritten and deployed manually.

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 databases

The instructions in this section describe how you can perform a data migration to upgrade the 3.1.0 database for use in CEP 4.0.0.

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.

  1. Before you upgrade to CEP 4.0.0, create a new database and restore the backup of the CEP 3.1.0 database in this new database.

    Note

    You should NOT connect a new version of WSO2 CEP to an older database that has not been upgraded.

  2. Select the relevant 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 CEP 4.0.0.

    Note

    There are three migration scripts available:  migration-service-provider.sql , migration-identity.sql and  migration.sql. However, only the  migration.sql script is required to be executed for the CEP database upgrade.

Handling Artifacts

Artifacts cannot be directly migrated from CEP 3.1.0 to CEP 4.0.0 since the configurable objects in CEP 4.0.0 are different to that in CEP 3.1.0. Therefore, the configuration should be handled as follows.

Artifact Type in CEP 3.1.0  

Replaced in CEP 4.0.0 ByNoteRecommended Action
  • Input Event Adapter
  • Event Builder
Event Receiver

The Event Receiver artifact in CEP 4.0.0 embeds both the Input Event Adapter and Event Builder artifacts in CEP 3.1.0.

Identify the input event adapters and event builders used in combination in CEP 3.1.0, and redefine them as event receivers. For detailed instructions, see Configuring Event Receivers.

  • Event Stream
N/A 

Redefine the event streams in CEP 4.0.0. For detailed instructions, see Understanding Event Streams.

  • Output Event Adapter
  • Event Formatter
Event PublisherThe Event Publisher artifact in CEP 4.0.0 embeds both the Output Event Adapter and Event Formatter artifacts in CEP 3.1.0.

Identify the output event adapters and event formatters used in combination in CEP 3.1.0, and redefine them as event publishers. For detailed instructions, see Configuring CEP to Create Alerts.

  • Execution Plan
N/A

The Siddhi Query Language in CEP 4.0.0 is different to that in CEP 3.1.0.
Therefore, the Siddhi queries of an execution plan directly migrated from CEP 3.1.0 cannot function in CEP 4.0.0.

Redefine the execution plans in CEP 4.0.0.

For detailed instructions on defining execution plans, see Creating a Standalone Execution Plan and Creating a Storm Based Distributed Execution Plan.

For the modified Siddhi Query Language, see SiddhiQL Guide 3.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.
  • No labels