Recovering from a disaster

Reinstall the portal subsystem by using your infrastructure configuration backup, then restore the portal database backup.

Before you begin

To successfully recover the portal subsystem, you must have the following backups:

About this task

  • Portal subsystem backups can be restored in the same environment where they were taken, or in a different environment that has the same network configuration, endpoints, and deployment profile. You cannot restore a portal subsystem backup in a different network environment, form factor, or deployment profile. If you want to move your API Connect deployment to a different form factor or change endpoints, see Migrating from v10 to v10 on a different form factor.
    Note: If your management platform API endpoint changed since the portal database backup was created, you can update this setting during portal database restore by using the customPlatformApiHostname property in the PortalRestore CR. This is the only exception to the identical endpoints requirement. See Restore portal database.
  • When you restore a portal database backup, you must first restore the database backup of the management subsystem that the portal is registered with. Portal and management databases must remain in sync.
Note: For OpenShift® users: The steps that are detailed in this topic use the Kubernetes kubectl command. On OpenShift, use the equivalent oc command in its place.

Procedure

  1. Reinstall your portal subsystem by using the YAML files from your Infrastructure configuration backup.
    Your infrastructure configuration backup consists of:
    • Portal CR YAML: portal_cr_backup.yaml.
    • Portal database encryption secret: portal_enc_key_backup.yaml.
    • Portal backup server credentials secret: ptl-backup-secret_backup.yaml.
    • If required, the portal backup server CA certificate secret: portal_custom_s3_ca.yaml.
    • If you customized any portal certificates, a YAML file of the secret for each customized certificate. For example: portalWeb_secret_backup.yaml.
    1. Create the database encryption secret with the portal_enc_key_backup.yaml: 
      kubectl -n <portal namespace> apply -f portal_enc_key_backup.yaml
    2. Create the backup credential secrets with your ptl-backup-secret_backup.yaml file: 
      kubectl -n <portal namespace> apply -f ptl-backup-secret_backup.yaml
    3. Create the S3 CA secret (if required) with: 
      kubectl -n <portal namespace> apply -f portal_custom_s3_ca.yaml
    4. Create the secrets for any customized certificates from their backup files: 
      kubectl -n <portal namespace> apply -f <custom certificate secret backup file>
    5. Install the portal subsystem. Follow the installation procedures for your platform: Deployment procedures, but use the settings from the spec section of your portal_cr_backup.yaml file.
      Note:
      • Cloud Pak for Integration users: Many of the portal configuration settings can be configured in Cloud Pak for Integration Platform UI. You do not need to edit the YAML directly.
  2. Restore your portal database: Restoring from a portal database backup.