Supported steps to backup and restore a 3scale operator-based deployment?

Solution Verified - Updated

Environment

  • Red Hat 3scale API Management (3scale)
    • 2.X On-Premises
  • Backups
  • Operator-based install
  • Internal or externalized databases

Issue

  • Can the steps in 3scale backup and restore using templates be used?
  • What is the correct way to backup?
  • Does the APIManagerBackup custom resource backup method work with internal databases?

Resolution

There are 2 ways to backup and restore a 3scale operator based deployment depending on the 3scale version:

  1. Until 3scale 2.11 the only supported steps to backup and restore 3scale deployed with the Operator are described in the chapter 3scale backup and restore:

    • Backup: refer to Backing up system databases section.
    • Restore: start from Restoring an operator-based deployment section.

  2. From 3scale 2.12 both procedures are supported:

    • Backup and restore described above.
    • Backup and restore using Custom Resources when the databases are external
    • Important: When databases are internal, APIManagerBackup CR can't be used, backup and restore should be done as described above.

  3. In 3scale 2.15 Openshift APIs for Data Protection as the standard backup and restore mechanism was introduced. Other procedures are deprecated.

Root Cause

A This content is not included.bug has been opened to change the title of the chapter 3scale backup and restore using templates since it also contains the steps to backup/restore an operator deployment.

The 3scale 2.12 documentation that describes usage of the APIManagerBackup has caused some confusion about how to do the backup because only works for externalized databases. It only stores the resources and doesn't export the database data, and its restore process doesn't provide for a method to restore the databases during the restore operation. The documentation does mention externalized database prerequisites, but there has been some confusion because it doesn't mention in that section what to do in the default case of internal databases.

SBR
Product(s)
Category
Tags

This solution is part of Red Hat’s fast-track publication program, providing a huge library of solutions that Red Hat engineers have created while supporting our customers. To give you the knowledge you need the instant it becomes available, these articles may be presented in a raw and unedited form.