Skip to content

Commit 12560c6

Browse files
authored
Merge pull request #75004 from anarnold97/CNV-35150
CNV#35150: removing OADP from Virt docs
2 parents 6b67635 + 1891635 commit 12560c6

12 files changed

+49
-218
lines changed

_topic_maps/_topic_map.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4338,14 +4338,8 @@ Topics:
43384338
Topics:
43394339
- Name: Backup and restore by using VM snapshots
43404340
File: virt-backup-restore-snapshots
4341-
- Name: Installing and configuring OADP
4342-
File: virt-installing-configuring-oadp
43434341
- Name: Backing up and restoring virtual machines
43444342
File: virt-backup-restore-overview
4345-
- Name: Backing up virtual machines
4346-
File: virt-backing-up-vms
4347-
- Name: Restoring virtual machines
4348-
File: virt-restoring-vms
43494343
- Name: Disaster recovery
43504344
File: virt-disaster-recovery
43514345
# - Name: Collecting OKD Virtualization data for community report

_topic_maps/_topic_map_osd.yml

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1699,14 +1699,8 @@ Topics:
16991699
Topics:
17001700
- Name: Backup and restore by using VM snapshots
17011701
File: virt-backup-restore-snapshots
1702-
- Name: Installing and configuring OADP
1703-
File: virt-installing-configuring-oadp
1704-
- Name: Backing up and restoring virtual machines
1705-
File: virt-backup-restore-overview
1706-
- Name: Backing up virtual machines
1707-
File: virt-backing-up-vms
1708-
- Name: Restoring virtual machines
1709-
File: virt-restoring-vms
1702+
# - Name: Backing up and restoring virtual machines
1703+
# File: virt-backup-restore-overview
17101704
# - Name: Collecting OKD Virtualization data for community report
17111705
# File: virt-collecting-virt-data
17121706
# Distros: openshift-origin

_topic_maps/_topic_map_rosa.yml

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1960,14 +1960,8 @@ Topics:
19601960
Topics:
19611961
- Name: Backup and restore by using VM snapshots
19621962
File: virt-backup-restore-snapshots
1963-
- Name: Installing and configuring OADP
1964-
File: virt-installing-configuring-oadp
1965-
- Name: Backing up and restoring virtual machines
1966-
File: virt-backup-restore-overview
1967-
- Name: Backing up virtual machines
1968-
File: virt-backing-up-vms
1969-
- Name: Restoring virtual machines
1970-
File: virt-restoring-vms
1963+
# - Name: Backing up and restoring virtual machines
1964+
# File: virt-backup-restore-overview
19711965
# - Name: Removed topics (Placeholder for topics removed from topic map)
19721966
# Dir: Removed_topics
19731967
# Topics:

modules/install-and-configure-oadp-kubevirt.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
As a cluster administrator, you install {oadp-short} by installing the {oadp-short} Operator.
1010

11-
The Operator installs link:https://velero.io/docs/v{velero-version}[Velero {velero-version}].
11+
The latest version of the {oadp-short} Operator installs link:https://velero.io/docs/v{velero-version}[Velero {velero-version}].
1212

1313
.Prerequisites
1414

modules/oadp-installing-dpa-1-2-and-earlier.adoc

Lines changed: 1 addition & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You install the Data Protection Application (DPA) by creating an instance of the
1818
* You must configure object storage as a backup location.
1919
* If you use snapshots to back up PVs, your cloud provider must support either a native snapshot API or Container Storage Interface (CSI) snapshots.
2020
* If the backup and snapshot locations use the same credentials, you must create a `Secret` with the default name, `{credentials}`.
21-
ifdef::installing-oadp-azure,installing-oadp-gcp,installing-oadp-mcg,installing-oadp-ocs,virt-installing-configuring-oadp[]
21+
ifdef::installing-oadp-azure,installing-oadp-gcp,installing-oadp-mcg,installing-oadp-ocs[]
2222
* If the backup and snapshot locations use different credentials, you must create two `Secrets`:
2323
2424
** `Secret` with a custom name for the backup location. You add this `Secret` to the `DataProtectionApplication` CR.
@@ -299,51 +299,6 @@ spec:
299299
<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.
300300
<11> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
301301
endif::[]
302-
ifdef::virt-installing-configuring-oadp[]
303-
+
304-
[source,yaml,subs="attributes+"]
305-
----
306-
apiVersion: oadp.openshift.io/v1alpha1
307-
kind: DataProtectionApplication
308-
metadata:
309-
name: <dpa_sample>
310-
namespace: openshift-adp
311-
spec:
312-
configuration:
313-
velero:
314-
defaultPlugins:
315-
- kubevirt <1>
316-
- gcp <2>
317-
- csi <3>
318-
- openshift <4>
319-
resourceTimeout: 10m <5>
320-
restic:
321-
enable: true <6>
322-
podConfig:
323-
nodeSelector: <node_selector> <7>
324-
backupLocations:
325-
- velero:
326-
provider: {provider} <8>
327-
default: true
328-
credential:
329-
key: cloud
330-
name: <default_secret> <9>
331-
objectStorage:
332-
bucket: <bucket_name> <10>
333-
prefix: <prefix> <11>
334-
----
335-
<1> The `kubevirt` plugin is mandatory for {VirtProductName}.
336-
<2> Specify the plugin for the backup provider, for example, `gcp`, if it exists.
337-
<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.
338-
<4> The `openshift` plugin is mandatory.
339-
<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.
340-
<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.
341-
<7> Specify on which nodes Restic is available. By default, Restic runs on all nodes.
342-
<8> Specify the backup provider.
343-
<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.
344-
<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.
345-
<11> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
346-
endif::[]
347302

348303
. Click *Create*.
349304

modules/oadp-installing-dpa-1-3.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
77
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
88
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc
9+
// * virt/backup_restore/virt-backup-restore-overview.adoc
910

1011
:_mod-docs-content-type: PROCEDURE
1112
[id="oadp-installing-dpa-1-3_{context}"]
@@ -19,7 +20,7 @@ You install the Data Protection Application (DPA) by creating an instance of the
1920
* You must configure object storage as a backup location.
2021
* If you use snapshots to back up PVs, your cloud provider must support either a native snapshot API or Container Storage Interface (CSI) snapshots.
2122
* If the backup and snapshot locations use the same credentials, you must create a `Secret` with the default name, `{credentials}`.
22-
ifdef::installing-oadp-azure,installing-oadp-gcp,installing-oadp-mcg,installing-oadp-ocs,virt-installing-configuring-oadp[]
23+
ifdef::installing-oadp-azure,installing-oadp-gcp,installing-oadp-mcg,installing-oadp-ocs[]
2324
* If the backup and snapshot locations use different credentials, you must create two `Secrets`:
2425
2526
** `Secret` with a custom name for the backup location. You add this `Secret` to the `DataProtectionApplication` CR.
@@ -321,7 +322,7 @@ spec:
321322
<14> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
322323
endif::[]
323324

324-
ifdef::installing-oadp-kubevirt,virt-installing-configuring-oadp[]
325+
ifdef::virt-backup-restore-overview,installing-oadp-kubevirt[]
325326
+
326327
[source,yaml,subs="attributes+"]
327328
----

modules/oadp-setting-resource-limits-and-requests.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
// Module included in the following assemblies:
22
//
33
// * backup_and_restore/application_backup_and_restore/configuring-oadp.adoc
4-
// * virt/backup_restore/virt-installing-configuring-oadp.adoc
54
// * backup_and_restore/application_backup_and_restore/oadp-aws-sts/oadp-aws-sts.adoc
65
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
76
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc

virt/backup_restore/virt-backing-up-vms.adoc

Lines changed: 0 additions & 65 deletions
This file was deleted.

virt/backup_restore/virt-backup-restore-overview.adoc

Lines changed: 36 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,54 @@ include::_attributes/common-attributes.adoc[]
33
[id="virt-backup-restore-overview"]
44
= Backing up and restoring virtual machines
55
:context: virt-backup-restore-overview
6+
:virt-backup-restore-overview:
7+
:credentials: cloud-credentials
8+
:provider: gcp
69

710
toc::[]
811

9-
//Hiding all links until PR 68901 merges
10-
ifndef::openshift-rosa,openshift-dedicated[]
11-
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)].
12+
You can install the {oadp-first} with {VirtProductName} by installing the {oadp-short} Operator and configuring a backup location. Then, you can install the Data Protection Application.
1213

13-
.Prerequisites
14+
Back up and restore virtual machines by using the xref:../../backup_and_restore/index.adoc#application-backup-restore-operations-overview[{oadp-full}].
1415

15-
* Access to the cluster as a user with the `cluster-admin` role.
16-
// Non-admin user [https://issues.redhat.com/browse/OADP-203] is targeted for OADP 1.2.
16+
[NOTE]
17+
====
18+
{oadp-full} with {VirtProductName} supports the following backup and restore storage options:
1719
18-
.Procedure
20+
* Container Storage Interface (CSI) backups
1921
20-
. 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.
21-
. 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].
22-
. 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)].
23-
. 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].
22+
* Container Storage Interface (CSI) backups with DataMover
23+
24+
The following storage options are excluded:
25+
26+
* File system backup and restore
27+
28+
* Volume snapshot backup and restore
29+
30+
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].
31+
====
32+
To install the {oadp-short} Operator in a restricted network environment, you must first disable the default OperatorHub sources and mirror the Operator catalog. See xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] for details.
33+
34+
include::modules/install-and-configure-oadp-kubevirt.adoc[leveloffset=+1]
2435

2536
[role="_additional-resources"]
26-
[id="additional-resources_virt-backup-restore-overview"]
27-
== Additional resources
37+
.Additional resources
2838

29-
* xref:../../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-features-plugins[OADP features and plugins]
30-
* xref:../../backup_and_restore/application_backup_and_restore/troubleshooting.adoc#troubleshooting[Troubleshooting]
31-
endif::openshift-rosa,openshift-dedicated[]
39+
* xref:../../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-plugins_oadp-features-plugins[{oadp-short} plugins]
40+
* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[`Backup` custom resource (CR)]
41+
* xref:../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#restoring-applications[`Restore` CR]
42+
* xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
3243
33-
ifdef::openshift-rosa,openshift-dedicated[]
34-
Back up and restore virtual machines by using the OpenShift API for Data Protection (OADP).
44+
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
3545

36-
.Prerequisites
46+
[IMPORTANT]
47+
====
48+
Red Hat supports using {VirtProductName} 4.14 or later with {oadp-short} 1.3.x or later.
3749
38-
* Access to the cluster as a user with the `cluster-admin` role.
39-
// Non-admin user [https://issues.redhat.com/browse/OADP-203] is targeted for OADP 1.2.
50+
{oadp-short} versions before 1.3.0 are not supported for back up and restore of {VirtProductName}.
51+
====
4052

41-
.Procedure
53+
:!provider:
54+
:!credentials:
55+
:!virt-backup-restore-overview:
4256

43-
. Install the OADP Operator according to the instructions for your storage provider.
44-
. Install the Data Protection Application with the `kubevirt` and `openshift` plugins.
45-
. Back up virtual machines by creating a `Backup` custom resource (CR).
46-
. Restore the `Backup` CR by creating a `Restore` CR.
47-
endif::openshift-rosa,openshift-dedicated[]

virt/backup_restore/virt-installing-configuring-oadp.adoc

Lines changed: 0 additions & 39 deletions
This file was deleted.

0 commit comments

Comments
 (0)