This documentation is for WSO2 API Manager 1.8.0 View documentation for the latest release.
Page Comparison - Upgrading from the Previous Release (v.2 vs v.18) - API Manager 1.8.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: ✉️ [APIM] - Need to Fix the Link of the Migration JAR

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

Table of Contents
maxLevel3
minLevel3

Migration scripts' location is https://svn.wso2.org/repos/wso2/carbon/platform/branches/turing/products/apimgt/1.8.0/modules/distribution/resources/migration-1.7.0_to_1.8.0.

Upgrading the product databases

  1. Download the API Manager 1.8.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.7.0 server instance.
  4. Go to <APIM_1.8.0_HOME>/dbscripts/migration-1.7.0_to_1.8.0 and run Download the migration scripts from the migration script location and execute the database upgrade scripts on your old database. You must select the script corresponding to your database type. For example, if your database is MySQL, execute <APIM_1.8.0_HOME>/dbscripts/execute migration-1.7.0_to_1.8.0/mysql.sql on it. The script adds all the schema changes done to API Manager tables in the 1.8.0 release.

...

  1. Open <APIM_1.8.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.7.0 instance.

    • User Store
    • Registry database
    • API Manager Databases
  2. Edit the registry configurations in the <APIM_HOME>/repository/config/registry.xml file 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.7.0_HOME>/repository/deployment/server/synapse-config/default directory to <APIM_1.8.0_HOME>/repository/deployment/server/synapse-config/default directory.

    Note

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

...

  1. Start the API Manager 1.8.0 and log in to its management console.

  2. Select Extensions -> Artifact Types menu and click the View/Edit link associated with the api artifact type.
    Image Removed
  3. Replace the RXT file that opens in the management console with the content of

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

    a) Rename the lastAccessTimeLocation in the <APIM_1.8.0_HOME>/

    dbscripts/migration-1.7.0_to_1.8.0/rxt/api.rxt file.
  4. Similarly, using the management console, replace the documentation.rxt file with the content of <APIM_1.8.0_HOME>/dbscripts/migration-1.7.0_to_1.8.0/rxt/documentation.rxt file.
  5. Copy the <APIM_1.8.0_HOME>/dbscripts/migration-1.7.0_to_1.8.0/swagger-resource-migration directory to <APIM_1.8.0_HOME>(The new directory path will now be

    repository/conf/registry.xml file.

    E.g.,: Change /_system/local/repository/components/org.wso2.carbon.registry/indexing/lastaccesstime to /_system/local/repository/components/org.wso2.carbon.registry/indexing/lastaccesstime_1

    b) Shutdown AM 1.8.0 and backup and delete the <APIM_1.8.0_HOME>/

    swagger-resource-migration).

    Configure <APIM_solr directory and restart the server.

  6. Copy the contents from your previous <APIM_HOME>/repository/tenants directory to the same directory in the API Manager 1.8.0_HOME>/swagger-resource-migration/build.xml file with the following properties:
    PropertyDescription
    registry.homePath to the APIM distribution. In a distributed setup, give the API Publisher node's path.
    usernameUsername for the server. For a tenant to log in, provide the tenant admin username.
    passwordPassword for the server. For a tenant to log in, provide the tenant admin password.
    hostIP of the running APIM server. In a distributed setup, give the host of the API Publisher node.
    portPort of the running APIM server. In a distributed setup, give the port of the APIM Publisher node.
    versionVersion of the server.
    Using the command line, go to . Do not replace the _TokenAPI_.xml, _RevokeAPI_.xml and _AuthorizeAPI_.xml files in the /default/api sub directory.
  7. Download and build org.wso2.carbon.apimgt.migration.zip as a JAR file.
  8. Place the JAR file in the <APIM_1.8.0_HOME>/swagger-resource-migration folder and execute ant run. If the above configuration is successful, you get a BUILD SUCCESSFUL message. It modifies the structure of Swagger content in the registry.

    Upgrading tenants

    If you have multiple tenants added to your API Manager instance, follow the steps below to migrate tenant configurations:Copy the contents from your previous <APIM_HOME>/repository/tenants directory to the same directory in the API Manager /repository/components/dropins folder.
  9. Start the server with the -Dmigrate=1.7 command to run the 1.7.0 to 1.8.0 swagger and doc resource migrations.  

  10. Execute steps 5 to 7 for all tenants in your system.
  11. Execute steps 9 to 11 for all tenants in your system.
  12. Upgrading external stores

  13. If you have external stores configured under the <ExternalAPIStores> element in <APIM_1.7.0_HOMe>/repository/conf/api-manager.xml filein the registry, follow the steps below:

    1. Log in to APIM 1.8.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 there and save.

    Upgrading Google analytics

  14. If you have Google Analytics configured under <GoogleAnalyticsTracking> element in <APIM_1.7.0_HOME>/repository/conf/api-manager.xml filein the registry, follow the steps below:

    1. Log in to APIM 1.8.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

  15. If you have Workflows configured under <WorkFlowExtensions> element in <APIM_1.7.0_HOME>/repository/conf/api-manager.xml filein the registry, follow the steps below:

    1. Log in to APIM 1.8.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.