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

Version 1 Next »

The instructions on this page takes you through the steps for upgrading to AS 5.2.1 version from a previous AS version. For more information on release versions, see the Release Matrix

If you want to migrate your WSO2 AS configurations from one instance to another (such as when promoting your instance from test to production) using the same AS version, see Migrating the Application Server.

The following two upgrades are separately explained in these instructions.

  • Upgrading from AS 5.2.0 (based on Carbon 4.2.0) to AS 5.2.1 (based on Carbon 4.2.0)
  • Upgrading from AS 5.1.0 (based on Carbon 4.1.0) to AS 5.2.1 (based on Carbon 4.2.0)

Go to the respective tabs given below to find the relevant instructions.

 

The instructions on this page takes you through the steps for upgrading from AS 5.1.0 to AS 5.2.1. This includes upgrading the database changes as well as the configurations that should follow the upgrade.

You cannot rollback the upgrade process. However, It is possible to restore a backup of the previous database and restart the upgrade progress.

Preparing to upgrade

The following prerequisites must be completed before upgrading:

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

 

Upgrading the database

  1. Before you upgrade to AS 5.2.1, create a new database and restore the backup of the old database in this new database.

    You should NOT connect a new version of WSO2 AS 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 database is upgraded with the additional tables and schemas that are required for AS 5.2.1.

    There are three migration scripts available: migration­service­provider.sql, migration­identity.sql and migration.sql. However, note that only the migration.sql script is required to be executed for AS 5.2.1.

Once you run the migration scripts on the new database, it becomes the upgraded database for AS 5.2.1.

Migrating the configurations

Once you have completed the database upgrade as explained in the previous steps, you must migrate the configurations from AS 5.1.0 to AS 5.2.1 as explained below.

Updating the configuration files

The following are the updates that need to be done to the configuration files in AS 5.2.1.

Note that configuration files should not be copied directly between servers.

  1. To connect AS 5.2.1 to the upgraded database, configure the following files:
    1. Configure the <AS_HOME_5.2.1>/repository/conf/datasources/master­datasources.xml file as shown in the following example:

      <datasource>
      user manager</description>
      <name>WSO2_CARBON_DB</name>
      <description>The datasource used for registry and
      <jndiConfig>
      <name>jdbc/WSO2CarbonDB</name>
      </jndiConfig>
      <definition type="RDBMS">
      <configuration>
      <url>jdbc:mysql://localhost:3306/<new_database></url>
      <username>username</username>
      <password>password</password>
      <driverClassName>com.mysql.jdbc.Driver</driverClassName>
      <maxActive>80</maxActive>
      <maxWait>60000</maxWait>
      <minIdle>5</minIdle>
      <testOnBorrow>true</testOnBorrow>
      <validationQuery>SELECT
      1</validationQuery>
      <validationInterval>30000</validationInterval>
      </configuration>
      </definition>
      </datasource>
    2. Go to the <AS _HOME_5.2.1>/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. The following are sample configurations if the datasource is “jdbc/WSO2CarbonDB”:

      registry.xml

      <dbConfig name="wso2registry">
      <dataSource>jdbc/WSO2CarbonDB</dataSource>
      </dbConfig>

      user­mgt.xml

      <UserManager>
      <Realm>
      <Configuration>
      ...
      <Property
      name="dataSource">jdbc/WSO2CarbonDB</Property>
      </Configuration>
      ...
      </Realm>
      </UserManager>
  2. Check for any other configurations that were done for AS 5.1.0 (based on your solutions), and update the configuration files in AS 5.2.1 accordingly. For example, external user stores, caching, mounting, etc.

    Note that the following configuration files have changed in AS 5.2.1:
    • carbon.xml
    • identity.xml
    • log4j.properties
    • user­mgt.xml
    • axis2.xml
    • axis2_client.xml
    • tenant­axis2.xml
    • thrift­agent­config.xml
    • bam.xml
    • cache.xml
    • config­validation.xml
    • launch.ini
    • cloud­services­desc.xml
    • authenticators.xml
    • cipher­text.properties
    • cipher­tool.properties
    • catalina­server.xml
    • webapp­classloading­environments.xml

    The following configuration files are newly added to AS 5.2.1:

    • trusted­idp­config.xml
    • logging­bridge.properties

Migrating the tenant settings and applications

You can migrate all artifacts etc. relevant to tenants by copying the following directories from the old server to the new server.

  1. To migrate the deployment artifacts, copy the <AS_HOME>/repository/deployment/server/ directory from AS 5.1.0 to AS 5.2.1.
  2. If multi­tenancy is used, copy the <AS_HOME>/repository/tenants/ directory from AS 5.1.0 to AS 5.2.1.
  3. If axis based services are included in the directories that were copied above, you must do the following:
    1. Open the metadata files corresponding to the axis services from the following locations:
      1. The metadata files of axis services for the super tenant are stored in the <AS_HOME_5.2.1>/repository/deployment/server/servicemetafiles/ folder.
      2. The metadata files of axis services for each tenant can be found in the <AS_HOME_5.2.1>/repository/tenants/<Tenant_No>/servicemetafiles/ folder.
    2. When you open each metadata file, remove all occurrences of the following:

      <module name="activation" version="2.1.0" type="engagedModules"/
  4. If any JAXRS and JAXWS applications were copied from the old server (in step 1 and step 2), they must be moved as follows:
    1. For the super tenant, these applications should be moved from the <AS_HOME_5.2.1>/repository/deployment/server/jaxwebapps/ folder to the <AS_HOME_5.2.1>/repository/deployment/server/webapps/ folder.
    2. For other tenants, these applications should be moved from the <AS_HOME_5.2.1>/repository/tenants/<Tenant_No>/jaxwebapps/ folder to the <AS_HOME_5.2.1>/repository/tenants/<Tenant_No>/webapp/ folder.
  5. Start WSO2 Application Server 5.2.1.
  6. If you have a Composite Application Archive (CAR) file in AS 5.1.0, you can manually deploy using the management console of AS 5.2.1. See the topic on Creating and Deploying Carbon Applications for instructions. Alternatively, without using the management console of AS 5.2.1, you can directly copy the following directories:

    1. For super tenant, copy the <AS_HOME_5.1.0>/repository/carbonapps/0/ directory to the <AS_HOME_5.2.1>/repository/deployment/server/carbonapps/ directory.

    2. For other tenants, copy the <AS_HOME_5.1.0>/repository/carbonapps/<Tenant_No> directory to the <AS_HOME_5.2.1>/repository/tenants/<Tenant_ID>/carbonapps/ directory.

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.

This page takes you through the steps for upgrading from AS 5.2.0 version to AS 5.2.1. Follow the steps given below.

Preparing to upgrade

The following prerequisites must be completed before upgrading:

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

Migrating the configurations

Since there are no database changes between these two AS versions, you are only required to migrate the configurations and settings from AS 5.2.0 to AS 5.2.1 as explained below.

Updating the configuration files

The following are the updates that need to be done to the configuration files in AS 5.2.1.

Note that configuration files should not be copied directly between servers.

  1. Create a new database for AS 5.2.1 and restore the backup of the old database in this new database.
  2. To connect AS 5.2.1 to the new database, configure the following files:
    1. Configure the <AS_HOME_5.2.1>/repository/conf/datasources/master­datasources.xml file as shown in the following example:

      <datasource>
      user manager</description>
      <name>WSO2_CARBON_DB</name>
      <description>The datasource used for registry and
      <jndiConfig>
      <name>jdbc/WSO2CarbonDB</name>
      </jndiConfig>
      <definition type="RDBMS">
      <configuration>
      <url>jdbc:mysql://localhost:3306/<new_database></url>
      <username>username</username>
      <password>password</password>
      <driverClassName>com.mysql.jdbc.Driver</driverClassName>
      <maxActive>80</maxActive>
      <maxWait>60000</maxWait>
      <minIdle>5</minIdle>
      <testOnBorrow>true</testOnBorrow>
      <validationQuery>SELECT
      1</validationQuery>
      <validationInterval>30000</validationInterval>
      </configuration>
      </definition>
      </datasource>
    2. Go to the <AS _HOME_5.2.1>/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. The following are sample configurations if the datasource is “jdbc/WSO2CarbonDB”:

      registry.xml

      <dbConfig name="wso2registry">
      <dataSource>jdbc/WSO2CarbonDB</dataSource>
      </dbConfig>

      user­mgt.xml

      <UserManager>
      <Realm>
      <Configuration>
      ...
      <Property
      name="dataSource">jdbc/WSO2CarbonDB</Property>
      </Configuration>
      ...
      </Realm>
      </UserManager>
  3. Check for any other configurations that were done for AS 5.2.0 (based on your solutions), and update the configuration files in AS 5.2.1 accordingly. For example, external user stores, caching, mounting, etc.

Migrating the tenant settings and applications

You can migrate all artifacts etc. relevant to tenants by copying the following directories from the old server to the new server.

  1. To migrate the deployment artifacts, copy the <AS_HOME>/repository/deployment/server/ directory from AS 5.2.0 to AS 5.2.1.
  2. If multi­tenancy is used, copy the <AS_HOME>/repository/tenants/ directory from AS 5.2.0 to AS 5.2.1.
  3. If axis based services are included in the directories that were copied above, you must do the following:
    1. Open the metadata files corresponding to the axis services from the following locations:
      1. The metadata files of axis services for the super tenant are stored in the <AS_HOME_5.2.1>/repository/deployment/server/servicemetafiles/ folder.
      2. The metadata files of axis services for each tenant can be found in the <AS_HOME_5.2.1>/repository/tenants/<Tenant_No>/servicemetafiles/ folder.
    2. When you open each metadata file, remove all occurrences of the following:

      <module name="activation" version="2.1.0" type="engagedModules"/
  4. If any JAXRS and JAXWS applications were copied from the old server (in step 1 and step 2), they must be moved as follows:
    1. For the super tenant, these applications should be moved from the <AS_HOME_5.2.1>/repository/deployment/server/jaxwebapps/ folder to the <AS_HOME_5.2.1>/repository/deployment/server/webapps/ folder.
    2. For other tenants, these applications should be moved from the <AS_HOME_5.2.1>/repository/tenants/<Tenant_No>/jaxwebapps/ folder to the <AS_HOME_5.2.1>/repository/tenants/<Tenant_No>/webapp/ folder.
  5. Start WSO2 Application Server 5.2.1.
  6. If you have a Composite Application Archive (CAR) file in AS 5.1.0, you can manually deploy using the management console of AS 5.2.1. See the topic on Creating and Deploying Carbon Applications for instructions. Alternatively, without using the management console of AS 5.2.1, you can directly copy the following directories:

    1. For super tenant, copy the <AS_HOME_5.1.0>/repository/carbonapps/0/ directory to the <AS_HOME_5.2.1>/repository/deployment/server/carbonapps/ directory.

    2. For other tenants, copy the <AS_HOME_5.1.0>/repository/carbonapps/<Tenant_No>/ directory to the <AS_HOME_5.2.1>/repository/tenants/<Tenant_ID>/carbonapps/ directory.

Testing the upgrade

Verify that all the required scenarios are working as expected with AS 5.2.1. This confirms that the upgrade is successful.

  • No labels