Platform Data Backup
IBM recommends that you backup the platform data immediately after the initial setup and once after every platform configuration deployment changes. For example, Changing the JVM heap memory.
When you perform platform data backup of a cluster, you must backup the data of each node though the configuration is expected to be consistent among the nodes.
The list of API Gateway configuration data and their respective location
is as follows:
Configuration | File name | Location | Is this supported by externalization? |
---|---|---|---|
Elasticsearch configuration | elasticsearch.yml | SAGInstallDir/InternalDataStore/config/ | No |
Elasticsearch client configuration | config.properties | SAGInstallDir/IntegrationServer/packages/WmAPIGateway/config/ resources/elasticsearch/ | Yes |
Kibana configuration | kibana.yml | SAGInstallDir/ apigateway/Dashboard/config/ | No |
UI configurations | uiconfiguration.properties | SAGInstallDir/apigatewayui/webapps/apigatewayui/WEB-INF/classes | No |
Master password | empw.dat | SAGInstallDir/IntegrationServer/config/empw.dat | Yes |
Server Ports configuration | If the portClusteringEnabled extended setting is set to false, you must create the server ports in each instance. | No | |
WebApp settings | server.xml | SAGInstallDir/apigatewayui/conf/server.xml | Yes |
setenv.bat (Windows) or setenv.sh (Unix) |
Custom JAVA and memory settings | SAGInstallDir/IntegrationServer/bin/setenv.bat or setenv.sh | No |
You can back up the platform data using the
administration/platformConfiguration
REST API. You can backup other
configurations manually. - For information on using the
administration/platformConfiguration
REST API, see Creating Platform Data Backup using API. - For the list of data that must be backed up manually, see Creating Platform Data Backup Manually.