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.
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
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.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
andTokenAPI.xml
files, do not replace them when copying. They are application-specific APIs.
Upgrading APIM 1.8.0 to 1.9.0
- Download the API Manager 1.9.0 from http://wso2.com/products/api-manager.
- Stop all running API Manager server instances.
Back up the databases of your API Manager 1.8.0 server instance.
Download the WSO2 Api Migration Client - v1.9.0
Copy the downloaded client into
<APIM_1.9.0_HOME>/repository/components/dropins/
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. Please note that if you run-Dmigrate=1.9
earlier , you do not need to run the following commands- For database migrations run -Dmigrate=1.9 -DmigrateDB=true
- For registry migrations run -Dmigrate=1.9 -DmigrateReg=true
- 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.
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
- 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 1.9.0. Do not replace the_TokenAPI_.xml
,_RevokeAPI_.xml
and_AuthorizeAPI_.xml
files in the/default/api
sub directory.
- Start the server
- Execute steps 3 and 4 for all tenants in your system.
- Execute steps 7 to 9 for all tenants in your system.
Upgrading external stores
- Copy the contents from your previous
If you have external stores configured in the registry, follow the steps below:
Log in to APIM 1.9.0 management console and click the Resources -> Browse menu.
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
If you have Google Analytics configured in the registry, follow the steps below:
Log in to APIM 1.9.0 management console and go to Resources -> Browse menu.
Load the
/_system/governance/apimgt/statistics/ga-config.xml
resource in the registry browser UI, configure the Google analytics and save.
Upgrading workflows
If you have Workflows configured in the registry, follow the steps below:
Log in to APIM 1.9.0 management console and go to Resources -> Browse menu.
Load the
/_system/governance/apimgt/applicationdata/workflow-extensions.xml
resource in the registry browser UI, configure your workflows and save.