Preparing the Developer Portal subsystem for disaster recovery on VMware

Prepare a Developer Portal subsystem for disaster recovery by taking specific steps immediately after the installation of the subsystem.

About this task

  • Perform this task before any disaster event occurs, and also prior to the installation of a replacement Developer Portal subsystem for the recovery process.
  • Best practice is to complete these steps immediately after initial configuration of a Developer Portal subsystem during your original v10 deployment.
  • Any local backups are presumed to have been lost in the disaster scenario and are non-recoverable in this procedure.
  • Successful disaster recovery depends on recovery of both the Management subsystem and the Developer Portal subsystem. You must complete preparation steps for both subsystems in order to achieve disaster recovery. For information about preparing the Management subsystem, see Preparing the management subsystem for disaster recovery on VMware.

    If you have to perform a restore, you must complete the restoration of the Management Service first, and then immediately restore the Developer Portal. Therefore, 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.


  1. Before the initial installation, configure the Developer Portal subsystem for database backups. See Configuring backup settings for the Developer Portal subsystem.
  2. Ensure you create a backup:
  3. Ensure that you have a backup of the original project directory, stored in a location from where it can always be retrieved.
    The original project directory created with APICUP during the initial product installation (for example, myProject), is required to both restore the database and to upgrade your deployment. You cannot restore the database or perform an upgrade without the initial project directory because it contains pertinent information about the cluster. Note that the endpoints and certificates cannot change; the same endpoints and certificates will be used in the restored or upgraded system.
  4. Optional: Take a Virtual Machine (VM) snapshot of all your VMs; see Using VM snapshots for infrastructure backup and disaster recovery for details. This action does require a brief outage while all of the VMs in the subsystem cluster are shut down - do not take snapshots of running VMs, as they might not restore successfully. VM snapshots can offer a faster recovery when compared to redeploying OVAs and restoring from normal backups.
    Important: VM snapshots are not an alternative to the standard Developer Portal backups that are described in the previous steps, and which must be taken in all circumstances.

What to do next

To restore the Developer Portal on VMware after a disaster, see Recovering the Developer Portal subsystem on VMware.