All docs This doc
||
Skip to end of metadata
Go to start of metadata

The following information describes how to upgrade your WSO2 API Manager (WSO2 API-M) environment from APIM 1.8.0/1.9.0/1.9.1/1.10.0/2.0.0/2.1.0 to 2.2.0 when WSO2 Identity Server (WSO2 IS) is the Key Manager

  • You can use the following steps in either one of the following situations:

    • You are currently using a WSO2 IS 5.3.0 vanilla distribution that has WSO2 API Management related Key Manager features installed on top of it.
    • You are currently using a pre-packaged WSO2 Identity Server 5.3.0 distribution.
  • If you wish to upgrade your APIM environment from API-M 2.1.0 to 2.2.0, which is using the default Key Manager that comes with WSO2 API-M out-of-the-box, follow the instructions in Upgrading from the Previous Release.

Follow the instructions below to upgrade WSO2 API-M from WSO2 API-M 2.1.0 to 2.2.0 when using WSO2 IS as the Key Manager:

  1. Download the pre-packaged WSO2 Identity Server 5.5.0 - Key Manager.

  2. Migrate the WSO2 Identity Server (WSO2 IS) from version 5.3.0 to 5.4.0.

  3. Migrate the WSO2 Identity Server (WSO2 IS) from version 5.4.0 to 5.5.0.

  4. Migrate the configuration of the Key Manager.
    Compare the old <IS_HOME>/repository/conf/api-manager.xml file with the latest api-manager.xml file in WSO2 IS 5.5.0, and redo the configuration changes in the new configuration files.
    This completes the WSO2 IS migration process. Now, you can proceed with the WSO2 APIM migration.
  5. Migrate WSO2 API-M from 2.1.0 to 2.2.0.
    Follow the instructions mentioned in the Upgrading from 2.1.0 to 2.2.0 tab, which is in Upgrading from the Previous Release, but skip step 2 - (6), which explains how to migrate the APIM Identity component.

If you wish to upgrade your APIM environment from API-M 2.0.0 to 2.2.0, which is using the default Key Manager that comes with WSO2 API-M out-of-the-box, follow the instructions in Upgrading from the Previous Release.

Follow the instructions below to upgrade WSO2 API-M from WSO2 API-M 2.0.0 to 2.2.0 when using WSO2 IS as the Key Manager:

  1. Download the pre-packaged WSO2 Identity Server 5.5.0 - Key Manager.
  2. Migrate the WSO2 Identity Server from version 5.2.0 to 5.5.0.
    For more information, see Upgrading from a Previous Release in the WSO2 Identity Server 5.5.0 documentation.
  3. Migrate the configuration of the Key Manager.
    Compare the old <IS_HOME>/repository/conf/api-manager.xml file with the latest api-manager.xml file in WSO2 IS 5.5.0, and redo the configuration changes in the new configuration files.
    This completes the WSO2 IS migration process. Now, you can proceed with the WSO2 APIM migration.
  4. Migrate WSO2 API-M from 2.0.0 to 2.2.0.
    Follow the instructions mentioned in the Upgrading from 2.0.0 to 2.2.0 tab, which is in Upgrading from the Previous Release, but skip step 2 - (6), which explains how to migrate the API-M Identity component.

  • You can use the following steps in either one of the following situations:

    • You are currently using a WSO2 IS 5.1.0 vanilla distribution that has WSO2 API Management related Key Manager features installed on top of it.
    • You are currently using a pre-packaged WSO2 Identity Server 5.1.0 distribution.
  • If you wish to upgrade your APIM environment from 1.10.0 to 2.2.0, which is using the default Key Manager that comes with WSO2 API-M out-of-the-box, follow the instructions in Upgrading from the Previous Release.

Follow the instructions below to upgrade WSO2 API-M from WSO2 API-M 1.10.0 to 2.2.0 when using WSO2 IS as the Key Manager:

  1. Upgrade the WSO2 Identity Server from version 5.1.0 to 5.2.0.
    1. Download the pre-packaged WSO2 Identity Server 5.2.0 - Key Manager.
    2. Migrate the WSO2 Identity Server from version 5.1.0 to 5.2.0.
      For more information, see Upgrading from the Previous Release in the WSO2 Identity Server 5.2.0 documentation.

      Expected Errors

      You will come across the following error. Do not get alarmed as this error is to be expected since you are yet to complete the migration process.

      ERROR {org.wso2.carbon.apimgt.impl.dao.ApiMgtDAO} -  Failed to check is exist: 50PerMin--1234
      com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: Table 'apimgt.AM_POLICY_APPLICATION' doesn't exist

      You should complete upgrading WSO2 Identity Server from version 5.1.0 to 5.2.0 (step 1) to start upgrading the WSO2 Identity Server from version 5.2.0 to 5.3.0 (step 2).

  2. Upgrade the WSO2 Identity Server from version 5.2.0 to 5.5.0.
    1. Download the pre-packaged WSO2 Identity Server 5.5.0 - Key Manager.
    2. Migrate the WSO2 Identity Server from version 5.2.0 to 5.5.0.
      For more information, see Upgrading from a Previous Release in the WSO2 Identity Server 5.5.0 documentation.
    3. Migrate the configuration of the Key Manager.
      Compare the old <IS_HOME>/repository/conf/api-manager.xml file with the latest api-manager.xml file in WSO2 IS 5.3.0, and redo the configuration changes in the new configuration files.
      This completes the IS migration process. Now, you can proceed with the WSO2 API Manager migration.
  3. Migrate WSO2 API-M from 1.10.0 to 2.2.0.
    Follow the instructions mentioned under Upgrading from 1.10.0 to 2.2.0, which is using the default Key Manager that comes with WSO2 API-M out-of-the-box, follow the instructions in which is in Upgrading from the Previous Release, but skip step 2 - (4), (5) and (10), which explains how to migrate the APIM Identity component.

  • You can use the following steps in either one of the following situations:

    • You are currently using a WSO2 IS 5.0.0 vanilla distribution that has WSO2 API Management related Key Manager features installed on top of it.
    • You are currently using a pre-packaged WSO2 Identity Server 5.0.0 distribution.
  • If you wish to upgrade your API-M environment from 1.8.0/1.9.0/1.9.1 to 2.2.0, which is using the default Key Manager that comes with WSO2 API-M out-of-the-box, follow the instructions in Upgrading from the Previous Release.

Follow the instructions below to upgrade WSO2 API-M from WSO2 API-M 1.8.0/1.9.0/1.9.1 to 2.2.0 when using WSO2 IS as the Key Manager:

  1. Upgrade the WSO2 Identity Server from version 5.0.0 to 5.1.0.
    1. Download the pre-packaged WSO2 Identity Server 5.1.0 - Key Manager.
    2. Migrate the WSO2 Identity Server from version 5.0.0 to 5.1.0.
      For more information, see Upgrading from the Previous Release in the WSO2 Identity Server 5.1.0 documentation.

  2. Upgrade the WSO2 Identity Server from version 5.1.0 to 5.2.0.
    1. Download the pre-packaged WSO2 Identity Server 5.2.0 - Key Manager.
    2. Migrate the WSO2 Identity Server from version 5.1.0 to 5.2.0.
      For more information, see Upgrading from the Previous Release in the WSO2 Identity Server 5.2.0 documentation.

      Expected Errors

      You will come across the following error. Do not get alarmed as this error is to be expected since you are yet to complete the migration process.

      ERROR {org.wso2.carbon.apimgt.impl.dao.ApiMgtDAO} -  Failed to check is exist: 50PerMin--1234
      com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: Table 'apimgt.AM_POLICY_APPLICATION' doesn't exist
  3. Upgrade the WSO2 Identity Server from version 5.2.0 to 5.3.0.
    1. Download the pre-packaged WSO2 Identity Server 5.5.0 - Key Manager.
    2. Migrate the WSO2 Identity Server from version 5.2.0 to 5.5.0.
      For more information, see Upgrading from a Previous Release in the WSO2 Identity Server 5.5.0 documentation.
    3. Migrate the configuration of the Key Manager.
      Compare the old <IS_HOME>/repository/conf/api-manager.xml file with the latest api-manager.xml file in WSO2 IS 5.5.0, and redo the configuration changes in the new configuration files.
      This completes the IS migration process. Now, you can proceed with the WSO2 API Manager migration.
  4. Migrate WSO2 API-M from 1.8.0/1.9.0/1.9.1 to 2.2.0.
    1. Migrate WSO2 API-M from 1.8.0/1.9.0/1.9.1 to 2.0.0.
      Follow the instructions mentioned is Upgrading from the Previous Release, but skip steps (7) and (10).

    2. Migrate WSO2 API-M from 2.0.0 to 2.2.0.
      Follow the instructions mentioned under Upgrading from 2.0.0 to 2.2.0, which is in Upgrading from the Previous Release, but skip step 2 - (6), which explains how to migrate the APIM Identity component.

  • No labels