Restoring the management database in a Kubernetes environment
The management database can be restored as a complete restoration. Partial restorations are not supported.
Before you begin
- If you have to perform a restore, you must complete the restoration of the Management Service first, and then immediately restore the Developer Portal. The backups of the Management and Portal must be taken at the same time to ensure that the Portal sites are consistent with Management database.
- Restoring the Management Service requires database downtime and is a destructive process that deletes current data and copies backup data. During the restoration process, external traffic must be stopped.
-
In a Disaster Recovery scenario, do not log in to the administration UI or attempt to configure or change any settings prior to restoring the backup. Restore the backup immediately after installing the subsystem.
-
To restore the management database, you must use the original project directory that was created with
apicup
during the initial product installation. You cannot restore the database without the initial project directory because it contains pertinent information about the cluster. The endpoints and certificates cannot change; the same endpoints and certificates will be used in the restored system. Note that successful restoration depends on use of a singleapicup
project for all subsystems, even those in a different cluster. Multiple projects will result in multiple certificate chains which will not match. - Map the DNS entries from the source cluster to the corresponding IP addresses on the target cluster. Record the DNS entries for each endpoint before starting the restore.
- When restoring the management database, the endpoints (on the new cluster which is the target for the restoration) have to be the same as those on the old cluster (the source of the backup). This includes all the endpoints for API Connect: api-manager-ui, cloud-admin-ui, consumer-api, platform-api; api-gateway, api-gw-service; analytics-ingestion, analytics-client; and portal-admin, portal-www.
- When restoring, the Gateway and all deployed subsystems (Management, Analytics, and Developer Portal) must be at the same version level.
About this task
Follow the procedure on this page to restore your management database. You must complete the prerequisite steps before beginning the restore.
Note that in a disaster recovery scenario you must first re-establish the management subystem. The procedure includes an optional first step for disaster recovery.
If you encounter errors, see Troubleshooting restoration of management database. Note that the troubleshooting page includes Overview of restore process for management database.