Chapter 10. 3scale backup and restore using custom resources

Procedure

1. Backup the following Kubernetes secrets:

   • backend-redis
   • system-redis
   • system-database
   • zync (optional)

2. Create the APIManagerBackup CR in the same namespace where the 3scale installation managed by the APIManager object is deployed, as in example one:

   Example 1

     apiVersion: apps.3scale.net/v1alpha1
     kind: APIManagerBackup
     metadata:
      name: example-apimanagerbackup-pvc
     spec:
       backupDestination:
         persistentVolumeClaim:
           resources:
             requests: "10Gi"

   Example 2 provides a pre-existing PersistentVolume name:

     apiVersion: apps.3scale.net/v1alpha1
     kind: APIManagerBackup
     metadata:
      name: example-apimanagerbackup-pvc
     spec:
       backupDestination:
         persistentVolumeClaim:
           # resources specification is required but ignored when providing a volumeName as per K8s PVCs requirements behavior
           resources:
             requests: "10Gi"
           volumeName: "my-preexisting-persistent-volume"

3. Wait until APIManagerBackup finishes. Check this by obtaining the content of APIManagerBackup and waiting until the .status.completed field is set to true.

1. Ensure that the project where you are performing the restoration does not contain an APIManager custom resource and its corresponding 3scale installation.

2. Restore the following Kubernetes secrets:

   • backend-redis
   • system-redis
   • system-database
   • zync secret if zync was an external database

3. Create the APIManagerRestore custom resource and specify the backup data of the installation that was previously backed up by an APIManagerBackup custom resource.

   For details, see Backup scenarios scope.

   The following is an example of an APIManagerRestore custom resource:

     apiVersion: apps.3scale.net/v1alpha1
     kind: APIManagerRestore
     metadata:
       name: example-apimanagerrestore-pvc
     spec:
      restoreSource:
        persistentVolumeClaim:
          claimSource:
            claimName: example-apimanagerbackup-pvc # Name of the PVC produced as the backup result of an `APIManagerBackup`
            readOnly: true

4. Wait until APIManagerRestore finishes. Check this by obtaining the content of APIManagerRestore and waiting until the .status.completed field is set to true.

   You should see a new APIManager custom resource has been created and a 3scale installation deployed.