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

Versions Compared

Key

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

...

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

  2. Copy the 'swagger-doc-migration' directory from the migration scripts location to <APIM_1.8.0_HOME>. The new directory path will now be <APIM_1.8.0_HOME>/swagger-doc-migration.

  3. Configure the <APIM_1.8.0_HOME>/swagger-doc-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.
  4. Using the command line, go to <APIM_1.8.0_HOME>/swagger-doc-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.

  5. 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>/repository/conf/registry.xml file.

    Eg: 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>/solr directory and restart the server.

    Upgrading tenants

  6. 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. Do not replace the _TokenAPI_.xml, _RevokeAPI_.xml and _AuthorizeAPI_.xml files in the /default/api sub directory.
    2. To upgrade the API and documentation RXT files, 
      1. Run the command sudo apt-get install xmlstarlet to install the xmlstarlet library. This is used for xml manipulation.

      2. Copy migrate.sh to the <APIM_1.8.0_HOME>/dbscripts/migration-1.7.0_to_1.8.0/rxt directory.
      3. Set the MySQL host, username, password and governance DB name in the migrate.sh script.
      4. Execute the script.

        Note

        Note that the script uses linux commands.

    3. Download Check out and build org.wso2.carbon.apimgt.migration and build  as a JAR file.
    4. Place the JAR file in the <APIM_1.8.0_HOME>/repository/components/dropins folder.
    5. Start the server with the -Dmigrate=1.7 command to run the 1.7.0 to 1.8.0 swagger and doc resource migrations.

    Upgrading external stores

  7. If you have external stores configured in 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 and save.

    Upgrading Google analytics

  8. If you have Google Analytics configured in 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

  9. If you have Workflows configured in 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.