Document navigation

Platform Database Backup

The backup service in ZSphere is based on periodic scheduled backups. To perform backups, configure a backup plan first. For more information, see Create a Backup Plan.

During backup plan execution, the backup cycle, execution time, start time, and backup data retention policy depend on the configured backup policy. For more information, see Backup Policy.

After backups are generated, you can use backup data to restore the platform database. For more information, see Data Recovery.

Backup Policy

Backup Policy

Backup Cycle

The backup cycle determines how frequently backups are performed. For platform database backups, ZSphere provides three options: weekly, daily, and hourly backups.

Execution Time
If the backup cycle is weekly or daily, you can configure a more granular backup execution time down to the minute.
  • Weekly backup: If the execution time is set to Sunday Tuesday 00:00, the backup starts at 00:00:00 every Sunday and Tuesday.
  • Daily backup: If the execution time is set to 00:30, the backup starts at 00:30:00 every day.
Start Time

The backup plan starts at the start time and performs backups based on the configured backup cycle and execution time.

Retention Policy

Each successful backup generates backup data that can be used to restore the platform database to an earlier point in time. To control the amount of backup data, specify a backup data retention policy. Based on the backup scenario, ZSphere can set retention policies separately for local backup data and remote backup data.
  • Local retention policy:
    • Retain by quantity: Retain at least the latest local backup data.
    • Retain by time: Retain local backup data for at least the latest 1 day.
  • Remote retention policy:
    • Permanent retention: Remote backup data is not automatically cleaned up.
    • Retain by quantity: Retain at least the latest remote backup data.
    • Retain by time: Retain remote backup data for at least the latest 1 day.
Note: Backup data outside the retention policy is removed only from the records. Data security is not affected.

Create a Backup Plan

Before you begin

  • Make sure the platform has sufficient authorized backup quota.
  • ZSphere supports only one platform database backup plan. Make sure no platform database backup plan already exists.

Procedure

  1. In the navigation pane, choose Data Protection > Backup Plan.
  2. On the Backup Plan page, click New Backup Plan.
  3. In the New Backup Plan dialog, complete the basic configuration and backup configuration.
  4. For Basic Configuration, configure the following options:

    Basic Information

    Option Description
    Name Name of the backup plan.
    Description Description of the backup plan.
    Data Center Select a data center.

    Backup Storage

    Option Description
    Local Backup Storage Add local backup storage. You can specify up to two backup storage resources for seamless failover.
    Sync to Remote Backup Storage Disabled by default. Choose whether to synchronize local backup data to remote backup storage.
    Note: If this option is enabled, add remote backup storage to the platform in advance. For more information, see Add Remote Backup Storage.
    Remote Backup Storage After Sync to Remote Backup Storage is enabled, displays the name and available capacity of the remote backup storage.

    Backup Object

    Option Description
    Backup Object Type Select Platform Database.
    Note: If a platform database backup plan already exists, the Platform Database option is not displayed.
  5. Review the basic configuration and click Next.
  6. For Backup Configuration, configure the following options:

    Backup Policy

    Option Description
    Backup Cycle Select a backup cycle as needed, including weekly, daily, and hourly backups.
    Execution Time Set the execution time after the backup cycle is set to weekly or daily.
    Start Time Set the start time of the backup plan.

    For more information about backup policies, see Backup Policy.

    Retention Policy

    Option Description
    Local Retention Policy Set the local backup retention policy by quantity or by time.
    Remote Retention Policy Set this parameter after Sync to Remote Backup Storage is enabled. Set the remote backup retention policy to permanent retention, retention by quantity, or retention by time.

    For more information about retention policies, see Backup Policy.

  7. Review the configuration and click OK.

What to do next

After backups are generated, you can use backup data to restore the platform database. For more information, see Data Recovery.

View Backup Plans and Data

During backup plan execution, you can view the execution status of backup plans to monitor backup activity in real time. For more information, see View Backup Plan Executions.

During backup plan execution, backup data is generated. You can view backup data for protected resources. For more information, see View Platform Database Backup Data.

View Backup Plan Executions

View the Latest Backup Result

Procedure:
  1. In the navigation pane, choose Data Protection > Backup Plan.
  2. In the list, view the latest backup result from Latest Backup Job Result.

View Backup Job Details in a Backup Plan

You can view details of each backup job, including the backup object, backup mode, number of backup resources, total backup capacity, backup job result, backup duration, start and completion time, and backup details.

Procedure
  1. In the navigation pane, choose Data Protection > Backup Plan.
  2. On the Backup Plan page, click the platform database backup plan name to go to the details page.
  3. On the backup plan details page, click Backup Job.
  4. On the Backup Job tab, select the backup job that you want to view, and then click View Backup Details.
  5. In the Backup Job Details dialog, view details of the backup job.

View Platform Database Backup Data

ZSphere provides a unified entry for viewing backup data of protected resources so that important protected workloads are not missed.

Procedure

  1. In the navigation pane, choose Data Protection > Protected Resources.
  2. On the Protected Resources page, select the Platform Database tab.
  3. View platform database backup data.
    The platform database backup data page is divided into tabs based on the storage location of the backup data:
    • Local Backup: Backup files are stored in local backup storage.
    • Remote Backup: Backup files are stored in remote backup storage.
    After selecting the required location, you can view the name, management node IP address, version, capacity, backup storage path or synchronization status to remote or local backup storage, and creation time of the platform database backup.
User Guide | ZStack ZSphere · ZVF | ZStack Resource Center