Upgrading from a Previous Release

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.

Preparing to upgrade

The following prerequisites must be completed before upgrading:

• Take a backup of the user and registry databases of AS 5.2.1

• Take a backup of <AS_HOME_5.2.1> folder to backup the product configurations. 

• Download WSO2 Application Server 5.3.0 from http://wso2.com/products/application-server/.

Upgrading the database

There are no registry and user database schema changes between AS 5.2.1 and 5.3.0. Therefore, you do not need to do any database schema migration. However, you should create a backup of the existing database, and create a duplicate database to use with a newer product version. This is described below.

Migrating the configurations

Before you start updating the configuration files in AS 5.3.0, create a new database and restore the backup of the old database in this new database.

Updating the configuration files

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

1. Create a new database for AS 5.3.0 and restore the backup of the old database in this new database.
2. To connect AS 5.3.0 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>

3. The SaaS application configuration in webapps has been changed. So, if you are using SaaS features, you need to update your web applications. Previously, users have configured the SaaS configuration via web.xml by adding a context-param called carbon.enable.saas.  In the new version, SaaS is configured via the context.xml configuration file that needs to be placed under the META-INF/ folder of the webapp. See the following documentation for more details -https://docs.wso2.com/display/AS530/Configuring+Applications+for+AS
4. KeyStore configuration in AS 5.2.1 has been converged into the carbon.xml. But users wanted to configure different keystore for SSL communication, and so on. Hence, in AS 5.3.0, users should separately configure the transport keystores through catalina-server.xml. The “RegistryKeyStore” configuration in carbon.xml has been removed. This is not really there in the AS 5.2.1, but was added later in a patch. This has been reverted in AS 5.3.0.
5. 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.
   

Migrating third party libraries

If there are any third party libraries used with AS 5.2.1 that you want to migrate, copy them to the  following directories as applicable to AS 5.3.0.

1.  If you have used JDBC drivers etc, copy them into <AS_HOME>/repository/components/lib
2. If you have used OSGi bundles such as SVNKit etc, copy them into <AS_HOME>/repository/components/dropins   

Migrating the services and artifacts

You can migrate all artifacts relevant to super-tenant and ordinary tenants by copying the following directories from the old server to the new server.

1. To migrate the super-tenant’s artifacts, copy the <AS_HOME>/repository/deployment/server/ directory from AS 5.2.1 to AS 5.3.0.

2. If you are using multi­-tenancy, copy the <AS_HOME>/repository/tenants/ directory from AS 5.2.1 to AS 5.3.0.

3. Since the Axis2 Quality of Services UI to apply policies such security has been removed from the management console, users need to use alternative mechanisms and apply the policies for their services. For Axis2 AAR services, the policies can be applied through the services.xml. Refer <link to page on how to apply QoS configuration if any> for more details. 

4. To globally engage modules, users need to use axis2.xml that can be found at AS_HOME/repository/conf/axis2 directory. Refer the following sample:
   

   <axisconfig name="AxisJava2.0">
       <module ref=”addressing”/>
       ....
   </axisconfig>

   The UI to globally engage a module is no longer available.

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.