1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

Enterprise-4.17 - CNV#35150: removing OADP from Virt docs

Signed-off-by: A.Arnold <anarnold@redhat.com>
This commit is contained in:
A.Arnold
2024-07-23 19:51:29 +01:00
parent ccdc2e39a2
commit 34e0937416
12 changed files with 67 additions and 222 deletions

View File

@@ -4396,14 +4396,8 @@ 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: 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: Disaster recovery
File: virt-disaster-recovery
# - Name: Collecting OKD Virtualization data for community report

View File

@@ -1696,14 +1696,10 @@ 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: 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

View File

@@ -1963,14 +1963,8 @@ 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: 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: Removed topics (Placeholder for topics removed from topic map)
# Dir: Removed_topics
# Topics:

View File

@@ -8,7 +8,7 @@
As a cluster administrator, you install {oadp-short} by installing the {oadp-short} Operator.
The Operator installs link:https://velero.io/docs/v{velero-version}[Velero {velero-version}].
The latest version of the {oadp-short} Operator installs link:https://velero.io/docs/v{velero-version}[Velero {velero-version}].
.Prerequisites

View File

@@ -18,7 +18,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[]
* 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.
@@ -93,7 +93,7 @@ spec:
credential:
key: cloud
name: {credentials} # <12>
----
<1> The `openshift` plugin is mandatory.
<2> 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.
@@ -312,51 +312,6 @@ spec:
<10> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
<11> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
endif::[]
ifdef::virt-installing-configuring-oadp[]
+
[source,yaml,subs="attributes+"]
----
apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
name: <dpa_sample>
namespace: openshift-adp
spec:
configuration:
velero:
defaultPlugins:
- kubevirt <1>
- gcp <2>
- csi <3>
- openshift <4>
resourceTimeout: 10m <5>
restic:
enable: true <6>
podConfig:
nodeSelector: <node_selector> <7>
backupLocations:
- velero:
provider: {provider} <8>
default: true
credential:
key: cloud
name: <default_secret> <9>
objectStorage:
bucket: <bucket_name> <10>
prefix: <prefix> <11>
----
<1> The `kubevirt` plugin is mandatory for {VirtProductName}.
<2> Specify the plugin for the backup provider, for example, `gcp`, if it exists.
<3> The `csi` plugin is mandatory for backing up PVs with CSI snapshots. The `csi` plugin uses the link:https://{velero-domain}/docs/main/csi/[Velero CSI beta snapshot APIs]. You do not need to configure a snapshot location.
<4> The `openshift` plugin is mandatory.
<5> 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.
<6> Set this value to `false` if you want to disable the Restic installation. Restic deploys a daemon set, which means that Restic pods run on each working node. In OADP version 1.2 and later, you can configure Restic for backups by adding `spec.defaultVolumesToFsBackup: true` to the `Backup` CR. In OADP version 1.1, add `spec.defaultVolumesToRestic: true` to the `Backup` CR.
<7> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
<8> Specify the backup provider.
<9> 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.
<10> Specify a bucket as the backup storage location. If the bucket is not a dedicated bucket for Velero backups, you must specify a prefix.
<11> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
endif::[]
. Click *Create*.

View File

@@ -6,6 +6,7 @@
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc
// * virt/backup_restore/virt-backup-restore-overview.adoc
:_mod-docs-content-type: PROCEDURE
[id="oadp-installing-dpa-1-3_{context}"]
@@ -19,7 +20,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[]
* 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.
@@ -333,7 +334,7 @@ spec:
<14> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
endif::[]
ifdef::installing-oadp-kubevirt,virt-installing-configuring-oadp[]
ifdef::virt-backup-restore-overview,installing-oadp-kubevirt[]
+
[source,yaml,subs="attributes+"]
----

View File

@@ -1,7 +1,6 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/configuring-oadp.adoc
// * virt/backup_restore/virt-installing-configuring-oadp.adoc
// * backup_and_restore/application_backup_and_restore/oadp-aws-sts/oadp-aws-sts.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc

View File

@@ -1,68 +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::[]
:FeatureName: OADP for {VirtProductName}
include::snippets/technology-preview.adoc[]
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[]

View File

@@ -3,45 +3,69 @@ include::_attributes/common-attributes.adoc[]
[id="virt-backup-restore-overview"]
= Backing up and restoring virtual machines
:context: virt-backup-restore-overview
:virt-backup-restore-overview:
:credentials: cloud-credentials
:provider: gcp
toc::[]
//Hiding all links until PR 68901 merges
[IMPORTANT]
====
Red Hat supports using {VirtProductName} 4.14 or later with {oadp-short} 1.3.x or later.
{oadp-short} versions earlier than 1.3.0 are not supported for back up and restore of {VirtProductName}.
====
ifndef::openshift-rosa,openshift-dedicated[]
Back up and restore virtual machines by using the xref:../../backup_and_restore/index.adoc#application-backup-restore-operations-overview[OpenShift API for Data Protection (OADP)].
.Prerequisites
* Access to the cluster as a user with the `cluster-admin` role.
// Non-admin user [https://issues.redhat.com/browse/OADP-203] is targeted for OADP 1.2.
.Procedure
. Install the xref:../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc#about-installing-oadp[OADP Operator] according to the instructions for your storage provider.
. Install the xref:../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc#oadp-installing-dpa_installing-oadp-ocs[Data Protection Application] with the `kubevirt` and `openshift` xref:../../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-plugins_oadp-features-plugins[plugins].
. Back up virtual machines by creating a xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[`Backup` custom resource (CR)].
. Restore the `Backup` CR by creating a xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#restoring-applications[`Restore` CR].
[role="_additional-resources"]
[id="additional-resources_virt-backup-restore-overview"]
== Additional resources
* xref:../../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-features-plugins[OADP features and plugins]
* xref:../../backup_and_restore/application_backup_and_restore/troubleshooting.adoc#troubleshooting[Troubleshooting]
Back up and restore virtual machines by using the xref:../../backup_and_restore/index.adoc#application-backup-restore-operations-overview[{oadp-full}].
endif::openshift-rosa,openshift-dedicated[]
ifdef::openshift-rosa,openshift-dedicated[]
Back up and restore virtual machines by using the OpenShift API for Data Protection (OADP).
Back up and restore virtual machines by using the {oadp-full}.
endif::openshift-rosa,openshift-dedicated[]
.Prerequisites
You can install the {oadp-first} with {VirtProductName} by installing the {oadp-short} Operator and configuring a backup location. You can then install the Data Protection Application.
* Access to the cluster as a user with the `cluster-admin` role.
// Non-admin user [https://issues.redhat.com/browse/OADP-203] is targeted for OADP 1.2.
.Procedure
[NOTE]
====
{oadp-full} with {VirtProductName} supports the following backup and restore storage options:
. Install the OADP Operator according to the instructions for your storage provider.
. Install the Data Protection Application with the `kubevirt` and `openshift` plugins.
. Back up virtual machines by creating a `Backup` custom resource (CR).
. Restore the `Backup` CR by creating a `Restore` CR.
endif::openshift-rosa,openshift-dedicated[]
* Container Storage Interface (CSI) backups
* Container Storage Interface (CSI) backups with DataMover
The following storage options are excluded:
* File system backup and restore
* Volume snapshot backup and restore
ifndef::openshift-rosa,openshift-dedicated[]
For more information, see xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/oadp-backing-up-applications-restic-doc.adoc#oadp-backing-up-applications-restic-doc[Backing up applications with File System Backup: Kopia or Restic].
endif::openshift-rosa,openshift-dedicated[]
====
To install the {oadp-short} Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog.
ifndef::openshift-rosa,openshift-dedicated[]
See xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.
endif::openshift-rosa,openshift-dedicated[]
include::modules/install-and-configure-oadp-kubevirt.adoc[leveloffset=+1]
ifndef::openshift-rosa,openshift-dedicated[]
[role="_additional-resources"]
.Additional resources
* xref:../../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-plugins_oadp-features-plugins[{oadp-short} plugins]
* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[`Backup` custom resource (CR)]
* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#restoring-applications[`Restore` CR]
* xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
endif::openshift-rosa,openshift-dedicated[]
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
:!provider:
:!credentials:
:!virt-backup-restore-overview:

View File

@@ -1,39 +0,0 @@
:_mod-docs-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-1-2-and-earlier.adoc[leveloffset=+1]
include::modules/oadp-installing-dpa-1-3.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!:

View File

@@ -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]

View File

@@ -26,6 +26,7 @@ endif::openshift-rosa,openshift-dedicated[]
* xref:../../virt/install/installing-virt.adoc#virt-installing-virt-operator_installing-virt[Install the {VirtProductName} Operator].
* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#installing-virtctl_virt-using-the-cli-tools[Install the `virtctl` command line interface (CLI) tool].
[discrete]
[id="additional-resources_planning-and-installing"]
[role="_additional-resources"]
@@ -101,5 +102,7 @@ Manage a VM:
* xref:../../virt/storage/virt-storage-config-overview.adoc#virt-storage-config-overview[Configure storage options and automatic boot source updates].
* xref:../../virt/monitoring/virt-monitoring-overview.adoc#virt-monitoring-overview[Learn about monitoring and health checks].
* xref:../../virt/live_migration/virt-about-live-migration.adoc#virt-about-live-migration[Learn about live migration].
* xref:../../virt/backup_restore/virt-backup-restore-overview.adoc#virt-backup-restore-overview[Back up and restore VMs].
ifndef::openshift-rosa,openshift-dedicated[]
* xref:../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#installing-oadp-kubevirt[Back up and restore VMs by using the {oadp-first}].
endif::openshift-rosa,openshift-dedicated[]
* link:https://access.redhat.com/articles/6994974[Tune and scale your cluster].