Merge pull request #47670 from sbeskin-redhat/OADP-563

mburke5678 · web-flow · commit 335eb39d57b1 · 2022-09-01T13:19:52.000-04:00
OADP-563: Update Velero references to 1.9
diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc
@@ -61,6 +61,9 @@ ifdef::openshift-origin[]
 :rh-virtualization: oVirt
 :rh-virtualization-engine-name: Engine
 endif::[]
+// Backup and restore
+:velero-domain: velero.io
+:velero-version: 1.9
 :launch: image:app-launcher.png[title="Application Launcher"]
 :mtc-short: MTC
 :mtc-full: Migration Toolkit for Containers
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -3466,8 +3466,14 @@ Topics:
 - Name: Backup and restore
   Dir: backup_restore
   Topics:
+  - Name: Installing and configuring OADP
+    File: virt-installing-configuring-oadp
   - Name: Backing up and restoring virtual machines
     File: virt-backup-restore-overview
+  - Name: Backing up virtual machines
+    File: virt-backing-up-vms
+  - Name: Restoring virtual machines
+    File: virt-restoring-vms
 #  - Name: Collecting OKD Virtualization data for community report
 #    File: virt-collecting-virt-data
 #    Distros: openshift-origin
diff --git a/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc b/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc
@@ -3,7 +3,6 @@
 = Backing up applications
 include::_attributes/common-attributes.adoc[]
 :context: backing-up-applications
-:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc b/backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc
@@ -3,7 +3,6 @@
 = Restoring applications
 include::_attributes/common-attributes.adoc[]
 :context: restoring-applications
-:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc b/backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc
@@ -3,11 +3,10 @@
 = About installing OADP
 include::_attributes/common-attributes.adoc[]
 :context: about-installing-oadp
-:velero-domain: velero.io
 
 toc::[]
 
-As a cluster administrator, you install the OpenShift API for Data Protection (OADP) by installing the OADP Operator. The OADP Operator installs link:https://{velero-domain}/docs/v1.7/[Velero 1.7].
+As a cluster administrator, you install the OpenShift API for Data Protection (OADP) by installing the OADP Operator. The OADP Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
 
 To back up Kubernetes resources and internal images, you must have object storage as a backup location, such as one of the following storage types:
 
@@ -37,4 +36,4 @@ You create a default `Secret` and then you install the Data Protection Applicati
 [role="_additional-resources"]
 == Additional resources
 
-* Overview of backup locations and snapshot locations in the link:https://{velero-domain}/docs/v1.7/locations/[Velero documentation].
+* link:https://{velero-domain}/docs/v{velero-version}/locations/[Overview of backup and snapshot locations in the Velero documentation]
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
@@ -6,11 +6,10 @@ include::_attributes/common-attributes.adoc[]
 :installing-oadp-aws:
 :credentials: cloud-credentials
 :provider: aws
-:velero-domain: velero.io
 
 toc::[]
 
-You install the OpenShift API for Data Protection (OADP) with Amazon Web Services (AWS) by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v1.7/[Velero 1.7].
+You install the OpenShift API for Data Protection (OADP) with Amazon Web Services (AWS) by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
 
 You configure AWS for Velero, create a default `Secret`, and then install the Data Protection Application.
 
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
@@ -6,11 +6,10 @@ include::_attributes/common-attributes.adoc[]
 :installing-oadp-azure:
 :credentials: cloud-credentials-azure
 :provider: azure
-:velero-domain: velero.io
 
 toc::[]
 
-You install the OpenShift API for Data Protection (OADP) with Microsoft Azure by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v1.7/[Velero 1.7].
+You install the OpenShift API for Data Protection (OADP) with Microsoft Azure by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
 
 You configure Azure for Velero, create a default `Secret`, and then install the Data Protection Application.
 
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
@@ -6,11 +6,10 @@ include::_attributes/common-attributes.adoc[]
 :installing-oadp-gcp:
 :credentials: cloud-credentials-gcp
 :provider: gcp
-:velero-domain: velero.io
 
 toc::[]
 
-You install the OpenShift API for Data Protection (OADP) with Google Cloud Platform (GCP) by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v1.7/[Velero 1.7].
+You install the OpenShift API for Data Protection (OADP) with Google Cloud Platform (GCP) by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
 
 You configure GCP for Velero, create a default `Secret`, and then install the Data Protection Application.
 
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
@@ -6,11 +6,10 @@ include::_attributes/common-attributes.adoc[]
 :installing-oadp-mcg:
 :credentials: cloud-credentials
 :provider: aws
-:velero-domain: velero.io
 
 toc::[]
 
-You install the OpenShift API for Data Protection (OADP) with Multicloud Object Gateway (MCG) by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v1.7/[Velero 1.7].
+You install the OpenShift API for Data Protection (OADP) with Multicloud Object Gateway (MCG) by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
 
 You configure xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#installing-oadp-mcg[Multicloud Object Gateway] as a backup location.
 MCG is a component of {rh-storage}. You configure MCG as a backup location in the `DataProtectionApplication` custom resource (CR).
diff --git a/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc b/backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
@@ -6,7 +6,6 @@ include::_attributes/common-attributes.adoc[]
 :installing-oadp-ocs:
 :credentials: cloud-credentials
 :provider: gcp
-:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc b/backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
@@ -3,7 +3,6 @@
 = OADP features and plug-ins
 include::_attributes/common-attributes.adoc[]
 :context: oadp-features-plugins
-:velero-domain: velero.io
 
 toc::[]
 
diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting.adoc
@@ -6,7 +6,6 @@ include::_attributes/common-attributes.adoc[]
 :oadp-troubleshooting:
 :namespace: openshift-adp
 :local-product: OADP
-:velero-domain: velero.io
 :must-gather: registry.redhat.io/oadp/oadp-mustgather-rhel8:v1.0
 
 toc::[]
diff --git a/backup_and_restore/index.adoc b/backup_and_restore/index.adoc
@@ -4,7 +4,6 @@
 include::_attributes/common-attributes.adoc[]
 :context: backup-restore-overview
 :backup-restore-overview:
-:velero-domain: velero.io
 
 toc::[]
 
@@ -35,8 +34,7 @@ You can always recover from a disaster situation by xref:../backup_and_restore/c
 
 As a cluster administrator, you can back up and restore applications running on {product-title} by using the OpenShift API for Data Protection (OADP).
 
-// Velero 1.7 is no longer latest version. However, it is the officially supported version, so do not change the version number without confirmation from PM.
-OADP backs up and restores Kubernetes resources and internal images, at the granularity of a namespace, by using link:https://{velero-domain}/docs/v1.7/[Velero 1.7]. OADP backs up and restores persistent volumes (PVs) by using snapshots or Restic. For details, see xref:../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-features_oadp-features-plugins[OADP features].
+OADP backs up and restores Kubernetes resources and internal images, at the granularity of a namespace, by using link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}]. OADP backs up and restores persistent volumes (PVs) by using snapshots or Restic. For details, see xref:../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-features_oadp-features-plugins[OADP features].
 
 [id="oadp-requirements"]
 === OADP requirements
diff --git a/modules/oadp-installing-operator.adoc b/modules/oadp-installing-operator.adoc
@@ -12,7 +12,7 @@
 
 You install the OpenShift API for Data Protection (OADP) Operator on {product-title} {product-version} by using Operator Lifecycle Manager (OLM).
 
-The OADP Operator installs link:https://{velero-domain}/docs/v1.7/[Velero 1.7].
+The OADP Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
 
 .Prerequisites
 
diff --git a/modules/oadp-plugins.adoc b/modules/oadp-plugins.adoc
@@ -3,10 +3,11 @@
 // * backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
 
 :_content-type: CONCEPT
+include::_attributes/common-attributes.adoc[]
 [id="oadp-plugins_{context}"]
 = OADP plug-ins
 
-The OpenShift API for Data Protection (OADP) provides default Velero plug-ins that are integrated with storage providers to support backup and snapshot operations. You can create link:https://{velero-domain}/docs/v1.7/custom-plugins/[custom plug-ins] based on the Velero plug-ins.
+The OpenShift API for Data Protection (OADP) provides default Velero plug-ins that are integrated with storage providers to support backup and snapshot operations. You can create link:https://{velero-domain}/docs/v{velero-version}/custom-plugins/[custom plug-ins] based on the Velero plug-ins.
 
 OADP also provides plug-ins for {product-title} resource backups, OpenShift Virtualization resource backups, and Container Storage Interface (CSI) snapshots.
 
diff --git a/modules/velero-obtaining-by-downloading.adoc b/modules/velero-obtaining-by-downloading.adoc
@@ -6,7 +6,7 @@
 [id="velero-obtaining-by-downloading_{context}"]
 = Downloading the Velero CLI tool
 
-You can download and install the Velero CLI tool by following the instructions on the link:https://velero.io/docs/v1.8/basic-install/#install-the-cli[Velero documentation page].
+You can download and install the Velero CLI tool by following the instructions on the link:https://{velero-domain}/docs/v{velero-version}/basic-install/#install-the-cli[Velero documentation page].
 
 The page includes instructions for:
 
@@ -21,7 +21,7 @@ The page includes instructions for:
 
 .Procedure
 
-. Open a browser and navigate to link:https://velero.io/docs/v1.8/basic-install/#install-the-cli["Install the CLI" on the Verleo website].
+. Open a browser and navigate to link:https://{velero-domain}/docs/v{velero-version}/basic-install/#install-the-cli["Install the CLI" on the Verleo website].
 . Follow the appropriate procedure for macOS, GitHub, or Windows.
 . Download the Velero version appropriate for your version of OADP, according to the table that follows:
 +
diff --git a/virt/backup_restore/virt-backing-up-vms.adoc b/virt/backup_restore/virt-backing-up-vms.adoc
@@ -0,0 +1,42 @@
+:_content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="virt-backing-up-vms"]
+= Backing up virtual machines
+:context: virt-backing-up-vms
+
+toc::[]
+
+You back up virtual machines (VMs) by creating an OpenShift API for Data Protection (OADP) xref:../../virt/backup_restore/virt-backing-up-vms.adoc#oadp-creating-backup-cr_virt-backing-up-vms[`Backup` custom resource (CR)].
+
+The `Backup` CR performs the following actions:
+
+* Backs up {VirtProductName} resources by creating an archive file on S3-compatible object storage, such as xref:../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc#installing-oadp-mcg[Multicloud Object Gateway], Noobaa, or Minio.
+* Backs up VM disks by using one of the following options:
+
+** xref:../../virt/backup_restore/virt-backing-up-vms.adoc#oadp-backing-up-pvs-csi_virt-backing-up-vms[Container Storage Interface (CSI) snapshots] on CSI-enabled cloud storage, such as Ceph RBD or Ceph FS.
+** xref:../../virt/backup_restore/virt-backing-up-vms.adoc#oadp-backing-up-applications-restic_virt-backing-up-vms[Restic file system backups] on object storage.
+
+[NOTE]
+====
+OADP provides backup hooks to freeze the VM file system before the backup operation and unfreeze it when the backup is complete.
+
+The `kubevirt-controller` creates the `virt-launcher` pods with annotations that enable Velero to run the `virt-freezer` binary before and after the backup operation.
+
+The `freeze` and `unfreeze` APIs are subresources of the VM snapshot API. See xref:../../virt/virtual_machines/virtual_disks/virt-managing-vm-snapshots.adoc#virt-about-vm-snapshots_virt-managing-vm-snapshots[About virtual machine snapshots] for details.
+====
+
+You can add xref:../../virt/backup_restore/virt-backing-up-vms.adoc#oadp-creating-backup-hooks_virt-backing-up-vms[hooks] to the `Backup` CR to run commands on specific VMs before or after the backup operation.
+
+You schedule a backup by creating a xref:../../virt/backup_restore/virt-backing-up-vms.adoc#oadp-scheduling-backups_virt-backing-up-vms[`Schedule` CR] instead of a `Backup` CR.
+
+include::modules/oadp-creating-backup-cr.adoc[leveloffset=+1]
+include::modules/oadp-backing-up-pvs-csi.adoc[leveloffset=+2]
+include::modules/oadp-backing-up-applications-restic.adoc[leveloffset=+2]
+include::modules/oadp-creating-backup-hooks.adoc[leveloffset=+2]
+
+include::modules/oadp-scheduling-backups.adoc[leveloffset=+1]
+
+[id="additional-resources_virt-backing-up-vms"]
+== Additional resources
+
+* xref:../../storage/container_storage_interface/persistent-storage-csi-snapshots.adoc#persistent-storage-csi-snapshots-overview_persistent-storage-csi-snapshots[Overview of CSI volume snapshots]
diff --git a/virt/backup_restore/virt-installing-configuring-oadp.adoc b/virt/backup_restore/virt-installing-configuring-oadp.adoc
@@ -0,0 +1,38 @@
+:_content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="virt-installing-configuring-oadp"]
+= Installing and configuring OADP
+:context: virt-installing-configuring-oadp
+:virt-installing-configuring-oadp:
+:credentials: cloud-credentials
+:provider: gcp
+
+toc::[]
+
+As a cluster administrator, you install the OpenShift API for Data Protection (OADP) by installing the OADP Operator. The Operator installs link:https://{velero-domain}/docs/v{velero-version}/[Velero {velero-version}].
+
+You create a default `Secret` for your backup storage provider and then you install the Data Protection Application.
+
+include::modules/oadp-installing-operator.adoc[leveloffset=+1]
+
+include::modules/oadp-about-backup-snapshot-locations-secrets.adoc[leveloffset=+1]
+include::modules/oadp-creating-default-secret.adoc[leveloffset=+2]
+include::modules/oadp-secrets-for-different-credentials.adoc[leveloffset=+2]
+
+[id="configuring-dpa-ocs"]
+== Configuring the Data Protection Application
+
+You can configure the Data Protection Application by setting Velero resource allocations or enabling self-signed CA certificates.
+
+include::modules/oadp-setting-resource-limits-and-requests.adoc[leveloffset=+2]
+include::modules/oadp-self-signed-certificate.adoc[leveloffset=+2]
+
+include::modules/oadp-installing-dpa.adoc[leveloffset=+1]
+include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
+
+[id="uninstalling-oadp_{context}"]
+== Uninstalling OADP
+
+You uninstall the OpenShift API for Data Protection (OADP) by deleting the OADP Operator. See xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-cluster[Deleting Operators from a cluster] for details.
+
+:virt-installing-configuring-oadp!:
diff --git a/virt/backup_restore/virt-restoring-vms.adoc b/virt/backup_restore/virt-restoring-vms.adoc
@@ -0,0 +1,14 @@
+:_content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="virt-restoring-vms"]
+= Restoring virtual machines
+:context: virt-restoring-vms
+
+toc::[]
+
+You restore an OpenShift API for Data Protection (OADP) `Backup` custom resource (CR) by creating a xref:../../virt/backup_restore/virt-restoring-vms.adoc#oadp-creating-restore-cr_virt-restoring-vms[`Restore` CR].
+
+You can add xref:../../virt/backup_restore/virt-restoring-vms.adoc#oadp-creating-restore-hooks_virt-restoring-vms[hooks] to the `Restore` CR to run commands in init containers, before the application container starts, or in the application container itself.
+
+include::modules/oadp-creating-restore-cr.adoc[leveloffset=+1]
+include::modules/oadp-creating-restore-hooks.adoc[leveloffset=+2]
