Upgrading Process

This section contains the complete upgrading process related to the WSO2 API Manager. Go through the guidelines given below before attempting to upgrade the production environment.

Note

To upgrade from a version older than 1.8.0 , follow the instructions in the document that was released immediately after your current release and upgrade incrementally.

Info

For more information about this release, see About this Release.

  1. If you already have a WSO2 subscription, reach out to our support team through your support account.

  2. Always migrate to the latest version since latest fixes and new features are available in the newest version. If you have a particular requirement to migrate to an intermediate version, contact WSO2 Support.

Note

Migrating the production environment requires additional hardware/VM resources since both the old environment and the new environment will be running until all the traffic is routed to the new environment.

  1. If you have customizations in your setup, check if they are supported out of the box in the latest version.

    • If your customizations are already available in the latest version, you can remove the customization after migration. You can contact WSO2 Support for assistance.
    • If any custom requirement is not available in the latest version, migrate the customization to support the latest product version. Note the following points.

      Migrating the customizations that are not available in the latest version

      • First update the dependency version of the dependant WSO2 components and re-build the customized component.
      • As a practice, WSO2 does not make API changes in minor releases of the dependency jars. However, if there are API changes, please update the custom code and re-build.
  2. List down the functional and nonfunctional use cases in your deployment and create test cases for them. NOTE: This step is crucial to verify that the migrated environment works as expected.

  3. Identify the configuration migrations required for the new setup. Refer Configuration Catalog for more information regarding the new config modal introduced.

  4. Prepare a test setup of the upgrading version with customizations and necessary config changes, and test your functional and nonfunctional requirements.

  5. Start the migration from the lowest environment such as dev and continue up to the highest before the production such as pre-prod. Run the test cases in the migrated environments to confirm that your functional and nonfunctional requirements are met in the migrated environment.

  6. Prior to the production migration, run a pilot migration on your pre-prod environment. It would be ideal if the pre-prod environment is similar to the production environment.

    • If possible, restore a database dump of the production environment to the pre-prod environment and perform the pilot migration.
    • If the production database dump cannot be used, at least ensure that you have a sufficient amount of data in the database to mimic the production environment.
  7. When you follow the above steps, you can get a rough estimate of the time for the final production update and you can allocate time slots as per the above analysis. WSO2 recommends performing the migration while the system is under minimum traffic.

Once you are satisfied with the above steps, proceed with production migration. After the migration is complete, verify it using the following steps.

  • Monitor the system health (CPU, memory usage etc).
  • Monitor the WSO2 logs for errors.
Top