Merge pull request #79808 from shdeshpa07/OADP-3920-add-review-section

OADP-3920 added review section for backup and restore

Author: skopacz1

backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc

@@ -33,6 +33,8 @@ include::snippets/pod-volume-restore-snapshot-read-only.adoc[]
 The {oadp-first} does not support backing up volume snapshots that were created by other software.
 ====
 
+include::modules/oadp-review-backup-restore.adoc[leveloffset=+1]
+
 You can create backup hooks to run commands before or after the backup operation. See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-creating-backup-hooks-doc.adoc#oadp-creating-backup-hooks-doc[Creating backup hooks].
 
 You can schedule backups by creating a `Schedule` CR instead of a `Backup` CR. See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-scheduling-backups-doc.adoc#oadp-scheduling-backups-doc[Scheduling backups using Schedule CR]].

backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc

@@ -10,5 +10,6 @@ You restore application backups by creating a `Restore` custom resource (CR). Se
 
 You can create restore hooks to run commands in a container in a pod by editing the `Restore` CR. See xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#oadp-creating-restore-hooks_restoring-applications[Creating restore hooks].
 
+include::modules/oadp-review-backup-restore.adoc[leveloffset=+1]
 include::modules/oadp-creating-restore-cr.adoc[leveloffset=+1]
 include::modules/oadp-creating-restore-hooks.adoc[leveloffset=+1]

modules/oadp-review-backup-restore.adoc

@@ -0,0 +1,53 @@
+// Module included in the following assemblies:
+//
+// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc
+// * backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="oadp-review-backup-restore_{context}"]
+= Previewing resources before running backup and restore
+
+{oadp-short} backs up application resources based on the type, namespace, or label. This means that you can view the resources after the backup is complete. Similarly, you can view the restored objects based on the namespace, persistent volume (PV), or label after a restore operation is complete. To preview the resources in advance, you can do a dry run of the backup and restore operations.
+
+.Prerequisites
+
+* You have installed the OADP Operator.
+
+.Procedure
+
+. To preview the resources included in the backup before running the actual backup, run the following command:
++
+[source,terminal]
+----
+$ velero backup create <backup-name> --snapshot-volumes false # <1>
+----
+<1> Specify the value of `--snapshot-volumes` parameter as `false`.
++
+. To know more details about the backup resources, run the following command:
++
+[source,terminal]
+----
+$ velero describe backup <backup_name> --details # <1>
+----
+<1> Specify the name of the backup.
++
+. To preview the resources included in the restore before running the actual restore, run the following command:
++
+[source,terminal]
+----
+$ velero restore create --from-backup <backup-name> # <1>
+----
+<1> Specify the name of the backup created to review the backup resources.
++
+[IMPORTANT]
+====
+The `velero restore create` command creates restore resources in the cluster. You must delete the resources created as part of the restore, after you review the resources.
+====
++
+. To know more details about the restore resources, run the following command:
++
+[source,terminal]
+----
+$ velero describe restore <restore_name> --details # <1>
+----
+<1> Specify the name of the restore.