Troubleshooting portal database backup and restore

Troubleshoot problems with portal database backups and restores.

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.
Check the status section of the PortalBackup or PortalRestore CR:
kubectl -n <portal namespace> get <portalbackup/portalrestore> <bup-name/restore-name> -o yaml
Example output:
apiVersion: portal.apiconnect.ibm.com/v1beta1
kind: PortalRestore
metadata:
  creationTimestamp: "2020-05-26T13:10:46Z"
  generateName: portal-restore-
  generation: 1
  name: portal-restore-x2bf9
  namespace: portal
  resourceVersion: "1493471"
  selfLink: /apis/portal.apiconnect.ibm.com/v1beta1/namespaces/portal/portalrestores/portal-restore-x2bf9
  uid: 9f6a1e22-55ab-4595-8b98-bdfaec40d58c
spec:
  portalCluster: portal
  type: site
status:
  backupId: ""
  commentLeft: ""
  conditions:
  - lastTransitionTime: "2020-05-26T13:10:49Z"
    message: |
      Please provide a site to restore. To restore all sites use value 'all' in the CR
    status: Failed
    type: Ready
  fullBackupName: ""
  id: ""
  message: ""
Check operator pod logs. Look for information in the logs of the ibm-apiconnect pod:
  • Locate the ibm-apiconnect pod with: 
    kubectl get pods -n <namespace-of-portal-subsystem>
  • View the logs with:
    kubectl logs <ibm-apiconnect-pod-NAME> -n <namespace-of-portal-subsystem>

Common problems with backup and restore

These are some frequent issues that can cause backup or restore to fail:
  • Invalid login credentials for your remote backup server. Check that the username and password that you configured in your subsystem database backup settings is correct.
  • The user does not have write permissions on the backup server. Check that the username you configured in your subsystem database backup settings has write permission to the specified backup path.
  • Remote backup server storage full. Check your remote backup server and if the storage is full either extend the storage space or delete older backups.
  • No network access to the remote backup server. Check that you can communicate with your remote backup server from your API Connect environment.
  • TLS handshaking failure with the remote backup server. If your remote backup server has a self-signed CA certificate, check that this certificate is trusted by your API Connect deployment, see the database backup configuration steps for your subsystem for more information.