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.3) - API Manager 1.8.0 - WSO2 Documentation

Versions Compared

Key

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

...

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 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/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. Start the API Manager 1.8.0 and log in to its management console.

  2. Copy the <APIM_1.8.0_HOME>/dbscripts/migration-1.7.0_to_1.8.0/swagger-doc-migration directory to <APIM_1.8.0_HOME>. The new directory path will now be <APIM_1..0_HOME>/swagger-doc-migration.

  3. Select Extensions -> Artifact Types menu and click the View/Edit link associated with the api artifact type.
  4. Replace the RXT file that opens in the management console with the content of <APIM_1.8.0_HOME>/dbscripts/migration-1.7.0_to_1.8.0/rxt/api.rxt file.
  5. 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.
  6. 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 <APIM_1.8.0_HOME>/swagger-resource-migration).
  7. Configure <APIM_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.
  8. Using the command line, go to <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

  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.8.0.  
    2. Execute steps 5 to 7 for all tenants in your system.
    3. Execute steps 9 to 11 for all tenants in your system.

    Upgrading external stores

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

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

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

    Upgrading Google analytics

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

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

    2. Load /_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 under <WorkFlowExtensions> element in <APIM_1.7.0_HOME>/repository/conf/api-manager.xml file, follow the steps below:

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

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