Data Type | How is it stored? | Where is it stored? | Migration information |
API Gateway assets | Documents | API Data Store or Elasticsearch | For more information on the procedure to migrate these data, see
Migrating the
API Gateway
assets and the analytics data. |
API Gateway analytics | Documents | API Data Store or Elasticsearch | For more information on the procedure to migrate these data, see
Migrating the
API Gateway
assets and the analytics data. |
Platform configurations | Files | On server nodes | For more information on the procedure to migrate these data, see
Migrating the platform configurations. |
Terminology | Description |
Source | The source API Gateway installation directory. |
Target | The target API Gateway installation directory. |
Quiesce | Quiescing API Gateway temporarily disables access to the server so you can perform the required tasks while the server is not connected to any external resources. In API Gateway, quiesce mode is used during the zero downtime upgrade wherein the access to the server is temporarily disabled, so you can perform the upgrade tasks. For more details, see
Quiesce Mode. |
Blue-Green | API Gateway follows Blue-Green deployment approach to upgrade to newer version in zero downtime. Blue-green deployment is a technique that reduces the downtime and risk by running two identical production environments called blue and green. In such a deployment scenario, the old instance of API Gateway is allowed to run and serve the transactions while the new instance of API Gateway is being prepared for data migration. |
Configuration | File name | File location | Is this supported by externalization? | Is this data migrated by the migrate.bat utility command? |
Elasticsearch configuration | elasticsearch.yml | SAGInstallDir/InternalDataStore/config/ | No | No |
Elasticsearch client configuration | config.properties | SAGInstallDir/IntegrationServer/instances/instance_name/packages/WmAPIGateway/config/resources/elasticsearch/ | Yes | No |
Kibana configuration | kibana.yml | SAGInstallDir/profiles/instance_name/apigateway/dashboard/config/ | Yes | No |
Master password | mpw.dat | SAGInstallDir/profiles/instance_name/configuration/security/passman/ | Yes | Yes |
UI configurations | uiconfiguration.properties | SAGInstallDir/profiles/instance_name/apigateway/config/ | No | Yes |
WebApp settings | com.softwareag.catalina.connector.http.pid-apigateway.properties com.softwareag.catalina.connector.https.pid-apigateway.properties You have to manually migrate the certificates used for the WebApp ports. | SAGInstallDir/profiles/instance_name/configuration/com.softwareag.platform.config.propsloader/ | Yes | Yes |
Custom wrapper settings | custom_wrapper.conf | SAGInstallDir/profiles/instance_name/configuration/ | No | Yes |
Server Ports Configuration | If the portClusteringEnabled extended setting is set to false, you must create the server ports in each instance. | No | No | |
Custom ESB packages | File name specified by users. Make sure that all the custom packages are installed and ready in the new instances. | Location used by users to save the file. Generally, the customized packages are saved in the following location: SAGInstallDir\IntegrationServer\tenant\packages\ | No | Yes |