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

« Previous Version 11 Next »

The following information describes how to upgrade your API Manager server from the previous release, which is APIM 1.8.0. To upgrade from a version older than 1.8.0, start from the doc that was released immediately after your current release and upgrade incrementally.

Migration scripts location:

 

Migrating the configurations

In this section, you move all existing API Manager configurations from the current environment to the new one.

  1. Open <APIM_1.9.0_HOME>/repository/conf/datasources/master-datasources.xml file and provide the datasource configurations for the following databases. You can copy the configurations from the same file in the API Manager 1.8.0 instance.

    • User Store
    • Registry database
    • API Manager Databases
  2. Edit the registry configurations in the <APIM_HOME>/repository/config/registry.xml and the user database in the <APIM_HOME>/repository/conf/user-mgt.xml file.

  3. Move all your synapse configurations by copying and replacing <APIM_1.8.0_HOME>/repository/deployment/server/synapse-config/default directory to <APIM_1.9.0_HOME>/repository/deployment/server/synapse-config/default directory.

    If you changed the default URLs in AuthorizeAPI.xml and TokenAPI.xml files, do not replace them when copying. They are application-specific APIs.

Upgrading APIM 1.8.0 to 1.9.0

  1. Download the API Manager 1.9.0 from http://wso2.com/products/api-manager.  
  2. Stop all running API Manager server instances.
  3. Back up the databases of your API Manager 1.8.0 server instance.

  4. Download the WSO2 Api Migration Client - v1.9.0 zip archive 

  5. Extract the downloaded client into <APIM_1.9.0_HOME>/repository/components/dropins/

  6. If you successfully extract you will see org.wso2.carbon.apimgt.migrate.client-1.9.0.jar and query.txt inside the dropins directory. Edit the query.txt according to your database type.

    The default file contains sql scripts for mysql.
     

    Example quaries for H2 

    SELECT DISTINCT constraint_name FROM information_schema.constraints WHERE table_name = 'AM_APP_KEY_DOMAIN_MAPPING';
    ALTER TABLE AM_APP_KEY_DOMAIN_MAPPING DROP CONSTRAINT <temp_key_name>;

  7. Start the API Manager 1.9.0 with the command -Dmigrate=1.9 for database, registry and file system migrations. If you need to perform single resource migrations you can use the following commands. If you run -Dmigrate=1.9 earlier , you do not need to run the following commands

    1. For database migrations  run -Dmigrate=1.9 -DmigrateDB=true
    2. For registry migrations  run -Dmigrate=1.9 -DmigrateReg=true
    3. For file system migrations  run -Dmigrate=1.9 -DmigrateFS=true

    Please note that if you run -Dmigrate=1.9 without any additional parameters, it migrates all the resources.

  8. To re-index the artifacts in the registry, perform the two steps given below.

    a) Rename the lastAccessTimeLocation in the <APIM_1.9.0_HOME>/repository/conf/registry.xml file. For example, change the /_system/local/repository/components/org.wso2.carbon.registry/indexing/lastaccesstime registry path to /_system/local/repository/components/org.wso2.carbon.registry/indexing/lastaccesstime_1.

    b) Shut down AM 1.9.0, backup and delete the <APIM_1.9.0_HOME>/repository/conf/solr directory and restart the server.

    Upgrading tenants

  9. If you have multiple tenants added to your API Manager instance, follow the steps below to migrate tenant configurations:
    1. Copy the contents from your previous <APIM_HOME>/repository/tenants directory to the same directory in the API Manager 1.9.0. Do not replace the _TokenAPI_.xml, _RevokeAPI_.xml and _AuthorizeAPI_.xml files in the /default/api sub directory.
    2. Start the server
    3. Execute steps 3 and 4 for all tenants in your system.
    4. Execute steps 7 to 9 for all tenants in your system.

    Upgrading external stores

  10. If you have external stores configured in the registry, follow the steps below:

    1. Log in to APIM 1.9.0 management console and click the Resources -> Browse menu.

    2. Load the /_system/governance/apimgt/externalstores/external-api-stores.xml resource in the registry browser UI, configure your external stores and save.

    Upgrading Google analytics

  11. If you have Google Analytics configured in the registry, follow the steps below:

    1. Log in to APIM 1.9.0 management console and go to Resources -> Browse menu.

    2. Load the /_system/governance/apimgt/statistics/ga-config.xml resource in the registry browser UI, configure the Google analytics and save.

    Upgrading workflows

  12. If you have Workflows configured in the registry, follow the steps below:

    1. Log in to APIM 1.9.0 management console and go to Resources -> Browse menu.

    2. Load the /_system/governance/apimgt/applicationdata/workflow-extensions.xml resource in the registry browser UI, configure your workflows and save.

  • No labels