Database Backup/Restore Add-On

The Database Backup add-on is compatible with all the MySQL-based (MySQL/MariaDB/Percona), PostgreSQL, and Redis databases in the Cloudjiffy Platform. Also this add-on is compatible with all the standalone and clustered (replica set) MongoDB databases.

It works in tandem with Backup Storage to help users automatically create and store database backups at the remote storage.

If you already have such storage, you can skip the Backup storage installation.

2. Within the installation window, you can choose between the Standalone and Cluster storage options.

Next, specify the preferred Number of nodes (for the Cluster option) and Storage size.

Finalize by providing the standard data:

• Environment – environment domain name
  
  
• Display Name – environment’s alias
  
  
• Region – environment’s region (if multiple ones are available)
  
  
  
  

3. Click the Install button and wait several minutes for the storage to be created. It will be automatically added to the “Backup storage nodes” group.

Tip: One storage can be used by as many databases as needed.

4. Once the storage is ready, you can install the backup add-on. Hover over your database and click the Add-Ons icon.

Locate the required Database Backup/Restore Add-On and click Install.

5. Provide the following data:

• Choose scheduling option
  
  
  • Pre-defined – select from a list of standard backup intervals (hourly, daily, weekly, monthly)
    
    
  • Custom – choose the exact Time, required Days of the week, and Time Zone
    
    
    
    
    
    
    
    
    
  • Manual (crontab) - provide a simple cron-based expression (using the UTC zone) to schedule backups
    
    
    
    
    
    
     
    • Backup storage – choose from the list of the backup storages installed on the account
      
      
    • Number of backups – set the number of the newest backups to keep for the current database
      
      
    • Database User and Database Password – provide user credentials to access the database
      
      
      
      
      
      
      
      
      
      

      6. In a minute, you’ll see the installation success pop-up.
      
      
      
      
      
      
      

      Your backup add-on is already working. Just wait for the specified time for backups to be created.
      
      
      
      
      

      Managing Add-On
      
      

      After the installation, the add-on gives you the options to:

      • Backup Now – creates an immediate backup
        
        
      • Configure – adjusts parameters specified during the creation (schedule, storage node, quantity of backups, user credentials)
        
        
      • Restore – restores from backup
        
        
      • Uninstall – removes the backup add-on
        
        
        
        
      
      
      During the backup process, a snapshot of the database is generated and stored in the Backup Storage.
      
      Each backup is placed within a dedicated folder named after the respective database, and the backup files are labeled with a unique execution timestamp.
      
      This structure ensures better organization and makes it easier to manage backups, especially when handling multiple databases.
      
      During the restore process, the corresponding directory on the storage server is mounted to the master node of the target database. Next, the SQL dump from the required backup snapshot is restored and applied to the database.
      
      
      

       Note: Take into consideration that all the operations are performed on the database layer’s master node only:

      • For the non-clustered databases with multiple nodes, the data will be restored on one node only.
        
        
      • For the primary-secondary topology, ensure that the primary node of the cluster is the master node of the layer.
        
        
        

         Restoring Database

        
        

        Database restoration from the backup overrides all the existing data. Any recent changes that were made since the backup creation will be permanently lost.

        In order to restore a database from a backup, you need to select the Restore option for the add-on. A dialogue window with the following options will be opened:

        • Restore from – choose the target environment (multiple options may be available if the backup add-on is used on several environments)
          
          
        • Backup – select from a list of backups for the selected environment (names contain timestamps for quick identification)
          
          
          
          
          
          
          Click Restore and confirm via pop-up. Once initiated, the action cannot be canceled or reverted.
          
          You’ll see the success notification in the dashboard after the process completion.

       

      How to Share Backup Storage Between Two Environments and Restore Database Using the Backup Add-On

      You can use a single backup storage environment to manage backups between multiple environments.

      Specifically, it demonstrates how to back up data from one environment (Source_Environment) and restore it into another (Destination_Environment) using a shared backup storage environment (Backup_Storage_Env) on the Cloudjiffy platform. 

      Environments Used

      Source_Environment: The environment containing the data to be backed up

      Destination_Environment: The environment where the backup will be restored

      Backup_Storage_Env: A dedicated environment to store backups
      

       

      1. Install Backup Add-On on Source_Environment

      - Navigate to the Add-Ons section of Source_Environment.

      - Install the Database Backup/Restore Add-On.

      - When prompted for Backup Storage Environment, select Backup_Storage_Env.

      - Complete the installation

      This links the source environment to use Backup_Storage_Env for storing its database backups.

      2. Create a Database Backup from Source_Environment

      - Navigate to the Database Backup/Restore Add-On in Source_Environment.

      - Click on Create Backup.

      - Wait for the process to complete.

      The backup will now be stored in Backup_Storage_Env.

       3. Install the Database Backup/Restore Add-On on Destination_Environment

      - Open the Add-Ons section of Destination_Environment.

      - Install the Database Backup/Restore Add-On.

      - Choose the same Backup Storage Environment: Backup_Storage_Env

      - Finish the setup

      Now, both environments are linked to the same storage and can access the same backups.

       4. Restore the Backup into Destination_Environment

      - Open the Database Backup/Restore Add-On in Destination_Environment

      - Click on Restore.

      - Under Restore From, select Source_Environment.

      - Choose the desired backup from the list.

      - Click Restore.

      The database backup from Source_Environment will now be successfully restored to Destination_Environment.