diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 428e4f8e9e42..dadf29550328 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -4188,14 +4188,14 @@ Topics: Topics: - Name: Backup and restore by using VM snapshots File: virt-backup-restore-snapshots - - Name: Installing and configuring OADP - File: virt-installing-configuring-oadp +# - 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: Backing up virtual machines +# File: virt-backing-up-vms +# - Name: Restoring virtual machines +# File: virt-restoring-vms - Name: Disaster recovery File: virt-disaster-recovery # - Name: Collecting OKD Virtualization data for community report diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml index db25730d8fcf..e5687b798ebf 100644 --- a/_topic_maps/_topic_map_osd.yml +++ b/_topic_maps/_topic_map_osd.yml @@ -1655,14 +1655,14 @@ Topics: Topics: - Name: Backup and restore by using VM snapshots File: virt-backup-restore-snapshots - - Name: Installing and configuring OADP - File: virt-installing-configuring-oadp +# - 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: 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/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index 9dfb2fb4a0ea..450f1be9350e 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -1896,14 +1896,17 @@ Topics: Topics: - Name: Backup and restore by using VM snapshots File: virt-backup-restore-snapshots - - Name: Installing and configuring OADP - File: virt-installing-configuring-oadp +# - 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: 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 # - Name: Removed topics (Placeholder for topics removed from topic map) # Dir: Removed_topics # Topics: diff --git a/modules/oadp-installing-dpa-1-3.adoc b/modules/oadp-installing-dpa-1-3.adoc index 2d01ad933743..e8a0bd051088 100644 --- a/modules/oadp-installing-dpa-1-3.adoc +++ b/modules/oadp-installing-dpa-1-3.adoc @@ -19,7 +19,7 @@ You install the Data Protection Application (DPA) by creating an instance of the * You must configure object storage as a backup location. * If you use snapshots to back up PVs, your cloud provider must support either a native snapshot API or Container Storage Interface (CSI) snapshots. * If the backup and snapshot locations use the same credentials, you must create a `Secret` with the default name, `{credentials}`. -ifdef::installing-oadp-azure,installing-oadp-gcp,installing-oadp-mcg,installing-oadp-ocs,virt-installing-configuring-oadp[] +ifdef::installing-oadp-azure,installing-oadp-gcp,installing-oadp-mcg,installing-oadp-ocs,installing-oadp-kubevirt,virt-installing-configuring-oadp[] * If the backup and snapshot locations use different credentials, you must create two `Secrets`: ** `Secret` with a custom name for the backup location. You add this `Secret` to the `DataProtectionApplication` CR. @@ -363,8 +363,8 @@ spec: <6> Specify how many minutes to wait for several Velero resources before timeout occurs, such as Velero CRD availability, volumeSnapshot deletion, and backup repository availability. The default is 10m. <7> The administrative agent that routes the administrative requests to servers. <8> Set this value to `true` if you want to enable `nodeAgent` and perform File System Backup. -<9> Enter `kopia` or `restic` as your uploader. You cannot change the selection after the installation. For the Built-in DataMover you must use Kopia. The `nodeAgent` deploys a daemon set, which means that the `nodeAgent` pods run on each working node. You can configure File System Backup by adding `spec.defaultVolumesToFsBackup: true` to the `Backup` CR. -<10> Specify the nodes on which Kopia or Restic are available. By default, Kopia or Restic run on all nodes. +<9> Enter `kopia` as your uploader, to use the Built-in DataMover. The `nodeAgent` deploys a daemon set, which means that the `nodeAgent` pods run on each working node. You can configure File System Backup by adding `spec.defaultVolumesToFsBackup: true` to the `Backup` CR. +<10> Specify the nodes on which Kopia are available. By default, Kopia run on all nodes. <11> Specify the backup provider. <12> Specify the correct default name for the `Secret`, for example, `cloud-credentials-gcp`, if you use a default plugin for the backup provider. If specifying a custom name, then the custom name is used for the backup location. If you do not specify a `Secret` name, the default name is used. <13> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix. diff --git a/modules/oadp-kubevirt-setting-resource-limits-and-requests.adoc b/modules/oadp-kubevirt-setting-resource-limits-and-requests.adoc new file mode 100644 index 000000000000..529428cbcd74 --- /dev/null +++ b/modules/oadp-kubevirt-setting-resource-limits-and-requests.adoc @@ -0,0 +1,48 @@ +// Module included in the following assemblies: +// +// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc + + +:_mod-docs-content-type: CONCEPT +[id="oadp-kubevirt-setting-resource-limits-and-requests_{context}"] += Velero CPU and memory resource allocations for {VirtProductName} + +You set the CPU and memory resource allocations for the `Velero` pod by editing the `DataProtectionApplication` custom resource (CR) manifest. + +.Prerequisites + +* You must have the OpenShift API for Data Protection (OADP) Operator installed. + +.Procedure + +* Edit the values in the `spec.configuration.velero.podConfig.ResourceAllocations` block of the `DataProtectionApplication` CR manifest, as in the following example: ++ +[source,yaml] +---- +apiVersion: oadp.openshift.io/v1alpha1 +kind: DataProtectionApplication +metadata: + name: +spec: +... + configuration: + velero: + podConfig: + nodeSelector: <1> + resourceAllocations: <2> + limits: + cpu: "1" + memory: 1024Mi + requests: + cpu: 200m + memory: 256Mi +---- +<1> Specify the node selector to be supplied to Velero podSpec. +<2> The `resourceAllocations` for backing up {VirtProductName} are most lkely to be more resource intensive than backing up containers. It is advisable to increase the memory and cpu limits. + + +[NOTE] +==== +Kopia is an option in OADP 1.3 and later releases. You can use Kopia for file system backups, and Kopia is your only option for Data Mover cases with the built-in Data Mover. +==== + diff --git a/virt/backup_restore/virt-backing-up-vms.adoc b/virt/backup_restore/virt-backing-up-vms.adoc deleted file mode 100644 index 682f8ae093e2..000000000000 --- a/virt/backup_restore/virt-backing-up-vms.adoc +++ /dev/null @@ -1,65 +0,0 @@ -:_mod-docs-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: - -// Hiding MOG from ROSA/OSD as not supported -ifndef::openshift-rosa,openshift-dedicated[] -* 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. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] -* Backs up {VirtProductName} resources by creating an archive file on S3-compatible object storage, such as Noobaa or Minio. -endif::openshift-rosa,openshift-dedicated[] - -// Hiding Backup/Restore link until 68901 is merged -ifndef::openshift-rosa,openshift-dedicated[] -* 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:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#backing-up-applications[Backing up applications with File System Backup: Kopia or Restic] on object storage. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] -* 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. -** Backing up applications with File System Backup: Kopia or Restic on object storage. -endif::openshift-rosa,openshift-dedicated[] - -[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/backup_restore/virt-backup-restore-snapshots.adoc#virt-about-vm-snapshots_virt-backup-restore-snapshots[About virtual machine snapshots] for details. -==== - -ifndef::openshift-rosa,openshift-dedicated[] -You can add xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-creating-backup-hooks-doc.adoc#backing-up-applications[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:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-scheduling-backups-doc.adoc#backing-up-applications[`Schedule` CR] instead of a `Backup` CR. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] -You can add hooks to the `Backup` CR to run commands on specific VMs before or after the backup operation. - -You schedule a backup by creating a `Schedule` CR instead of a `Backup` CR. -endif::openshift-rosa,openshift-dedicated[] - -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] - -ifndef::openshift-rosa,openshift-dedicated[] -[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] -endif::openshift-rosa,openshift-dedicated[] diff --git a/virt/backup_restore/virt-restoring-vms.adoc b/virt/backup_restore/virt-restoring-vms.adoc deleted file mode 100644 index fdac38112e7b..000000000000 --- a/virt/backup_restore/virt-restoring-vms.adoc +++ /dev/null @@ -1,14 +0,0 @@ -:_mod-docs-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]