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.
|Table of Contents|
Migrating the configurations
In this section, you move all existing API Manager configurations from the current environment to the new one.
Back up the databases in your API Manager instances and synapse configs in of all the tenants, including the super tenant. You find the synapse configs in
<APIM_1.9.0_HOME>/repository/conf/datasources/master-datasources.xmlfile 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_1.9.0_HOME>/repository/config/registry.xmland the user database in the
Move all your synapse configurations by copying and replacing
NOTE: Do not replace the
_AuthorizeAPI_.xmlfiles in the
/default/apisub directory unless you use a custom token endpoint. They are application-specific APIs.
Upgrading the API Manager from 1.8.0 to 1.9.0
Make sure you backed up all the databases and synapse configs as instructed in step 1 of the previous section.
Download WSO2 API Migration Client - v1.9.0
- Copy the
- Copy the
If you are not using the MySQL database with the API Manager, change the query inside
<APIM_1.9.0_HOME>/migration-scripts/18-19-migration/drop-fk.sql according to your database type. The scripts for each database type are given in the table below:
SELECT CONSTRAINT_NAME FROM information_schema.constraint_table_usage WHERE TABLE_NAME = 'AM_APP_KEY_DOMAIN_MAPPING';
ALTER TABLE AM_APP_KEY_DOMAIN_MAPPING DROP CONSTRAINT <temp_key_name>;
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 already executed
-Dmigrate=1.9, you do not need to execute the following commands:
- For database migrations run -DmigrateDB=1.9
- For registry migrations run -DmigrateReg=1.9
- For file system migrations run -DmigrateFS=1.9
To re-index the artifacts in the registry, perform the two steps given below.
a) Rename the lastAccessTimeLocation in the
repository/conf/registry.xmlfile. For example, change the
/_system/local/repository/components/org.wso2.carbon.registry/indexing/lastaccesstimeregistry path to
b) Shut down AM 1.9.0, backup and delete the
repository/conf/solrdirectory and restart the server.