Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This guide page takes you through the steps for upgrading product versions from DSS 3.1.0 to DSS 3.1.1. For more information on release versions, see the the  Release Matrix . 

Table of Contents
maxLevel3
minLevel3

Preparing to

...

 Before starting the upgrade, the following prerequisites must be followed on the database.

  • A separate staging database should run as the production database server. As a result, once the upgrade is completed, the database server should have the configurations required for a production server.
  • Take backups of the database and system prior to upgrading the database. The system backup can be taken by copying the Carbon server home folder.
  • Shut down all the Carbon servers connected to the database before running the upgrade scripts.
  • Since a separate database (staging database) is used for the upgrade instead of the actual production database, the data that is collected in the actual production system while the upgrade is in progress should later be added to the upgraded database using a script. 
  • The database administrator should collect the data portion that is added to the production database, while the upgrade is in progress. Generally, the WSO2 support team will provide help in these types of situations.
  • If any files/folders are changing in the product pack to which you are migrating, you need to make a backup of the relevant files/folders prior to changes.

    Note

    New product must not be connected to the old database without executing the upgrade script provided in the old database.

Limitations

Following are the limitations of upgrading:

  • This upgrade can only be done for some database types. For example, if you are using MySQL currently and you need to migrate to Oracle in the new version, these scripts will not work.
  • You cannot rollback an upgrade. It is impossible to restore a backup of the previous server and retry the migration progress.

Table of Contents
maxLevel3
minLevel3

upgrade

The following are the specific prerequisites you must complete before you upgrade from DSS 3.1.0 to DSS 3.1.1:

  • Before you upgrade to the latest version of WSO2 DSS, you create a staging database, which is essentially an empty database.

  • Stop all the Carbon servers connected to the database.

    Note

    Note that the upgrade should be done during a period when there is low traffic on the system.

Downtime

The downtime is limited to the time taken for switching databases when the migrating environment staging database is connected promoted to the actual production status.

Upgrade Procedure

Follow the instruction below to upgrade the system: 

...

Upgrading the configurations

To  migrate the configurations to the staging database:

...

  1. Copy the data from the old database to the staging database you created. This becomes the new database for your new version of WSO2 DSS.

  2. Download DSS 3.1.1 and connect it to your staging database.
  3. Configure the following files for the new production server. 
    • Go to the <DSS_HOME>/repository/conf/
    datasources/
    • datasources directory and update the  master-datasources.xml file .
    Refer - Go to the <PRODUCT
    • Go to the  <DSS_HOME>/repository/conf
     directory
    •   directory and update datasource references in
    the 
    • the  user-mgt.xml 
    and 
    •  and  registry.xml files.
     Refer  and 
  4. Start the server.

Recommended Checkpoints

...

  • UM_DOMAIN

  • UM_SYSTEM_USER

  • UM_SYSTEM_ROLE

  • UM_SYSTEM_USER_ROLE

  1. Copy the following directories from the old database to the staging database.
    • To migrate the super tenant settings, copy the <DSS_HOME>/repository/deployment/server directory.
    • If multitenancy is used, copy the <DSS_HOME>/repository/tenants directory.
  2. Check for any other configurations that were done for DSS 3.1.0 (based on your solutions), and update the configuration files in DSS 3.1.1 accordingly. For example, external user stores, caching, mounting, etc.

    Tip

    Note that the properties of data services listed below have changed for all 3.x.x versions of WSO2 DSS. Therefore, if you have any .dbs files moved from an older DSS version (DSS 2.x.x version) to DSS 3.1.1, be sure to update these properties as applicable to the DSS 3.x.x versions. The following table shows how the properties have changed between DSS 2.x.x versions to DSS 3.x.x versions.

    DSS 2.x.x versionsDSS 3.x.x versions
    org.wso2.ws.dataservice.driverdriverClassName
    org.wso2.ws.dataservice.protocolurl
    org.wso2.ws.dataservice.userusername
    org.wso2.ws.dataservice.passwordpassword
    org.wso2.ws.dataservice.query_timeoutqueryTimeout
    org.wso2.ws.dataservice.autocommitautoCommit
    org.wso2.ws.dataservice.fetch_directionfetchDirection
    org.wso2.ws.dataservice.fetch_sizefetchSize
    org.wso2.ws.dataservice.max_field_sizmaxFieldSize
    org.wso2.ws.dataservice.max_rowsmaxRows
    org.wso2.ws.dataservice.transaction_isolationdefaultTransactionIsolation
    org.wso2.ws.dataservice.initial_sizeinitialSize
    org.wso2.ws.dataservice.maxpoolsizemaxActive
    org.wso2.ws.dataservice.max_idlemaxIdle
    org.wso2.ws.dataservice.minpoolsizeminIdle
    org.wso2.ws.dataservice.max_waitmaxWait
    org.wso2.ws.dataservice.validation_queryvalidationQuery
    org.wso2.ws.dataservice.test_on_borrowtestOnBorrow
    org.wso2.ws.dataservice.test_on_returntestOnReturn
    org.wso2.ws.dataservice.test_while_idletestWhileIdle
    org.wso2.ws.dataservice.time_between_eviction_runs_millstimeBetweenEvictionRunsMillis
    org.wso2.ws.dataservice.num_test_per_eviction_runnumTestsPerEvictionRun
    org.wso2.ws.dataservice.min_evictable_idle_time_millisminEvictableIdleTimeMillis
    org.wso2.ws.dataservice.remove_abandonedremoveAbandoned
    org.wso2.ws.dataservice.remove_abandoned_timeoutremoveAbandonedTimeout
    org.wso2.ws.dataservice.log_abandonedlogAbandoned
    org.wso2.ws.dataservice.xa_datasource_classdataSourceClassName
    org.wso2.ws.dataservice.xa_datasource_propertiesdataSourceProps
    org.wso2.ws.dataservice.force_stored_procforceStoredProc
    org.wso2.ws.dataservice.force_jdbc_batch_requestsforceJDBCBatchRequests
  3. Start the server.

Going into production

The following are recommended tests to run on the staging system:. 

  • Create multiple user stores and try adding users to different user stores.

  • Create multiple tenants and add different user stores to the different tenants. Thereafter, add users to the various user stores.The staging database should be used as the new production database with the new Carbon server. The staging server should have the configurations equivalent to the production server. Map the production domain to the staging environment, when the staging environment is running smoothly. This upgrade should be done during a period when there is low traffic on the system. 

Once the above tests are run successfully, it is safe to consider that the upgrade is ready for production. However However, it is always advised to carryout testing on test any features that are being used in production.