Backup Plans - Actions

This page lists the various actions that may be executed by a user for a single backup plan.

The Backup & Recovery's Namespace page is primarily an informational page, presenting the user with a complete overview of everything related to their namespaces. However, there are some actions that the user can take, which are detailed in the following sections of this page. There are four actions that may be executed for a single namespace:

  • Edit

  • Clone

  • Create Backup

  • Create snapshot

  • Restore

  • View Backup & Restore summary

  • View Status Log

  • View YAML

  • Delete

Actions - Edit

From the Backup & Recovery's Backupplans page:

  1. Identify the listed backup plan that you wish to edit.

  2. Click the corresponding Edit button on the right side of the main UI window.

  3. Or Click on the action Dropdown From the menu displayed, select Edit.

  4. Depending on the backup plan selected, the Edit Backupplan (Applications), Edit Backupplan (Single Namespace), or Edit Multi-Namespace Backupplan displays. Refer respectively to Backup Plan - Application, Create Backup Plans, or Create Backup Plans for step-by-step details.

  5. Starting from version 5.0.3, users can edit a BackupPlan to change its associated target. This update is allowed only if all the existing Backups and Snapshots for that BackupPlan are already available on the new target(i.e. directories for all the existing Backups and Snapshots are present on the newly updated target). If they are not, the BackupPlan will enter an Unavailable state. Note: Chaing the target is currently supported only for BackupPlans, not for ClusterBackupPlans.

  6. Once all edits are completed, select Save.

Actions - Clone

From the Backup & Recovery's Backupplans page:

  1. Identify the listed backup plan that you wish to clone.

  2. Click on the action dropdown and select Clone.

  3. click on the cluster to open it.

  4. Select namespaces within the cluster you wish to crate the clone in.

  5. Once selected Click Clone.

    Clone Backup Plan

  6. In By Name sub tab give appropriate secret name, object store target name and backup plan name that will be used for the clone.

    Clone Backup Plan - By Name

  7. Or provide a suffix number that will be added to the end of the name of original secret name, original object store target name and original backup plan name to make new names for the clone in the By Suffix sub tab.

    Clone Backup Plan - By Suffix

Actions - Create Backup

From the Backup & Recovery's Backupplans page:

  1. Identify the listed backup plan that you wish to take a backup of.

  2. Click on the action dropdown and select Create Backup.

  3. Provide a meaningfull name to the Backup.

  4. Use the toggle switch to choose between Full backup and Incremental backup.

  5. click Create.

Actions - Create Snapshot

From the Backup & Recovery's Backupplans page:

  1. Identify the listed backup plan that you wish to snapshot.

  2. Click on the action dropdown and select Create Snapshot.

  3. Provide a meaningfull name to the snapshot.

  4. click Create

  5. click on the backup plan to view the backup plan summary.

Actions - Restore

From the Backup & Recovery's Backupplan page

  1. Identify the listed backup plan for which you wish to perform an action.

  2. Click the corresponding Actions button on the right side of the main UI window. Restore option only visible when there is successful Backup or Snapshot.

  3. From the menu displayed, select Restore.

  4. It initiates a restore based on last successful Backup or Snapshot.

    1. If last successful is Backup, Restore will be initiate for that Backup.

    2. If last successful is Snapshot, Restore will be initiate for that Snapshot.

  5. On click on Restore Create Restore model get open and for furthere Refer Restoring Backups & Snapshots

Actions - View Backup & Restore summary

From the Backup & Recovery's Backupplan page, follow the identical instructions found in Actions - View Backup & Restore summary.

Action - View Status Log

From the Backup & Recovery's Backupplans page:

  1. Identify the backup plan from the list whose status log you wish to view.

  2. Click on the action dropdown and select View Status Log.

  3. Click on collapsible icon to open the full details

Actions - View YAML

From the Backup & Recovery's Backupplans page:

  1. Identify the listed backup plan that you wish to view the YAML for.

  2. Click on the action dropdown.

  3. From the menu displayed, select View YAML.

  4. Depending on the backupplan type (Application, Single Namespace, or Multi-Namespace), the page displayed provides the ability to view and copy all associated YAML files. For example, for a Multi-Namespace backupplan, the available YAML files displayed are:

    • Clusterbackupplan

    • Incremental Schedule Policy

    • Schedule Policy

    • Retention Policy

    • Encryptions Secret

    • Target

    • Target Credential Secret

Multi-Namespace Backupplan YAMLs

Actions - Delete

From the Backup & Recovery's Backupplans page:

  1. Identify the listed backup plan that you wish to delete.

  2. Click the corresponding action dropdown on the right side of the Edit button.

  3. From the menu displayed, select Delete.

  4. When prompted "Are you sure you want to delete this backupplan?", click Yes.

PreviousCreate Backup PlansNextTargets

Last updated

Was this helpful?