Migrate API Gateway
This procedure explains how to migrate API Gateway when the new and old API Gateways are on the same machine or on different machines in the same network. If the new and old API Gateways are on machines in different networks, go to TECHcommunity for instructions on how to migrate.
1. Make sure the old API Gateway and its host Integration Server are shut down.
2. Go to the new_Software AG_directory/IntegrationServer/instances/instance_created_during_installation/packages/WmAPIGateway/bin/migrate directory.
3. Open the migration.properties file in a text editor. Set the following properties as needed:
Property | Default | Description |
apigateway.migration. srcTenantName | Old API Gateway tenant | If the old API Gateway had multiple tenants, specify the name of the old tenant from which to migrate data. |
apigateway.migration. batchSize | 100 | Batch size at which the data is migrated from the old node to the new node. For example, if the batch size is 100, the data is migrated in batches of 100 records. You can decrease or increase this value depending on whether your network is slow or fast. |
apigateway.migration. logLevel | info | The API Gateway migration writes detailed migration information to the command window and to the migrationLog.txt file in the new_Software AG_directory/install/logs directory. By default, it writes INFO, ERROR, and FATAL messages to the log. You can change the log level to INFO, DEBUG, ERROR, WARN, or TRACE. |
apigateway.migration. reindex.status.check. sleep.interval | 5000 milliseconds | Interval at which to check whether migration of a data store index has finished, so migration of the next index can begin. API Gateway migrates data from the old data store to the new data store one index at a time. API Gateway will not migrate an index until migration of the previous index has completed. Do not change from the default unless you have very little data to migrate and want to reduce the time between queries so the migration will proceed more quickly. |
4. Open a command window or shell.
a. Run the command below to migrate the data store:
migrate.{bat|sh} datastore -dstoreSrc full_path_to_old_config.properties
b. Run the command below to migrate API Gateway:
migrate.{bat|sh}
apigateway -srcDir full_path_to_old_Software AG_directory
-instanceName old_instance_name
If you experience problems during the migration, or if migration of API Gateway handlers fails, clean all data and indices from the new data store and then rerun the migration, as follows:
a. Stop the old data store to avoid data loss caused by incorrect configurations in the elasticsearch.yml or config.properties file.
b. Go to the new_Software AG_directory/IntegrationServer/instances/instance_created_during_installation/packages/WmAPIGateway/bin/migrate directory, open a command window or shell, and run the command below to clean the data store.
migrate.{bat|sh} clean
c. Re-run the commands for migrating the data store and API Gateway.
6. Start the new API Gateway. The new data store should start automatically.
7. In
Prepare the Old
API Gateway, you might have changed the ports used by the new data store to be different from the ports used by the old data store. If desired, you can now change those port values back by following the same instructions in
Prepare the Old
API Gateway. 8. If the old API Gateway used an external Elasticsearch data store instead of the API Gateway data store, and the version of that Elasticsearch data store was lower than version 6, you must change a API Gateway configuration setting to support backwards compatibility with the Elasticsearch data store. Open the new API Gateway user interface, go to Administration > General > Extended Settings, and set useTypeInIndexNameForESDestination to false.