Skip to content

Commit e446e03

Browse files
snarayan-redhatsnarayan-redhat
authored
Merge pull request #74926 from anarnold97/OADP-3399-Reworking-OpenShift-KubeVirt-OADP-docs
OADP-3399: Reworking OpenShift KubeVirt OADP-docs
2 parents 0977beb + deed3fe commit e446e03

10 files changed

+122
-2
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3078,6 +3078,8 @@ Topics:
30783078
File: installing-oadp-mcg
30793079
- Name: Configuring OADP with ODF
30803080
File: installing-oadp-ocs
3081+
- Name: Configuring OADP with OpenShift Virtualization
3082+
File: installing-oadp-kubevirt
30813083
- Name: Uninstalling OADP
30823084
Dir: installing
30833085
Topics:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,9 @@ include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
3838
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
3939
include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
4040

41+
[role="_additional-resources"]
42+
.Additional resources
43+
44+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins]
45+
4146
:!installing-oadp-aws:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,9 @@ include::modules/oadp-installing-dpa-1-2-and-earlier.adoc[leveloffset=+1]
3535
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
3636
include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
3737

38+
[role="_additional-resources"]
39+
.Additional resources
40+
41+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins]
42+
3843
:installing-oadp-azure!:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,9 @@ include::modules/oadp-gcp-wif-cloud-authentication.adoc[leveloffset=+1]
3636
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
3737
include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
3838

39+
[role="_additional-resources"]
40+
.Additional resources
41+
42+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins]
43+
3944
:installing-oadp-gcp!:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="installing-oadp-kubevirt"]
3+
4+
= Configuring the {oadp-full} with {VirtProductName}
5+
include::_attributes/common-attributes.adoc[]
6+
:context: installing-oadp-kubevirt
7+
:installing-oadp-kubevirt:
8+
:credentials: cloud-credentials
9+
:provider: kubevirt
10+
11+
toc::[]
12+
13+
You can install the {oadp-first} with {VirtProductName} by installing the OADP Operator and configuring a backup location. Then, you can install the Data Protection Application.
14+
15+
Back up and restore virtual machines by using the xref:../../../backup_and_restore/index.adoc#application-backup-restore-operations-overview[{oadp-full}].
16+
17+
[NOTE]
18+
====
19+
{oadp-full} with {VirtProductName} supports the following backup and restore storage options:
20+
21+
* Container Storage Interface (CSI) backups
22+
23+
* Container Storage Interface (CSI) backups with DataMover
24+
25+
The following storage options are excluded:
26+
27+
* File system backup and restore
28+
29+
* Volume snapshot backups and restores
30+
31+
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].
32+
====
33+
To install the OADP 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.
34+
35+
include::modules/install-and-configure-oadp-kubevirt.adoc[leveloffset=+1]
36+
37+
[role="_additional-resources"]
38+
.Additional resources
39+
40+
* xref:../../../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-plugins_oadp-features-plugins[{oadp-short} plugins]
41+
* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[`Backup` custom resource (CR)]
42+
* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/restoring-applications.adoc#restoring-applications[`Restore` CR]
43+
* xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
44+
45+
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
46+
47+
[IMPORTANT]
48+
====
49+
Red Hat only supports the combination of {oadp-short} versions 1.3.0 and later, and {VirtProductName} versions 4.14 and later.
50+
51+
{oadp-short} versions before 1.3.0 are not supported for back up and restore of {VirtProductName}.
52+
====
53+
54+
55+
:!installing-oadp-kubevirt:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,7 @@ include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
4747
.Additional resources
4848

4949
* link:https://access.redhat.com/solutions/6719951[Performance tuning guide for Multicloud Object Gateway].
50+
51+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins]
52+
53+
:installing-oadp-mcg!:

‎backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,9 @@ include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
4646
include::modules/oadp-creating-object-bucket-claim.adoc[leveloffset=+2]
4747
include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]
4848

49+
[role="_additional-resources"]
50+
.Additional resources
51+
52+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc#oadp-installing-dpa-1-3_installing-oadp-kubevirt[Installing the Data Protection Application with the `kubevirt` and `openshift` plugins]
4953

5054
:installing-oadp-ocs!:

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="install-and-configure-oadp-kubevirt_{context}"]
7+
= Installing and configuring {oadp-short} with {VirtProductName}
8+
9+
As a cluster administrator, you install {oadp-short} by installing the {oadp-short} Operator.
10+
11+
The Operator installs link:https://velero.io/docs/v{velero-version}[Velero {velero-version}].
12+
13+
.Prerequisites
14+
15+
* Access to the cluster as a user with the `cluster-admin` role.
16+
17+
.Procedure
18+
19+
. Install the {oadp-short} Operator according to the instructions for your storage provider.
20+
21+
. Install the Data Protection Application (DPA) with the `kubevirt` and `openshift` {oadp-short} plugins.
22+
23+
. Back up virtual machines by creating a `Backup` custom resource (CR).
24+
25+
+
26+
[WARNING]
27+
====
28+
Red Hat support is limited to only the following options:
29+
30+
* CSI backups
31+
32+
* CSI backups with DataMover.
33+
====
34+
35+
You restore the `Backup` CR by creating a `Restore` CR.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
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
8-
8+
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc
99

1010
:_mod-docs-content-type: PROCEDURE
1111
[id="oadp-installing-dpa-1-3_{context}"]
@@ -321,7 +321,7 @@ spec:
321321
<14> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
322322
endif::[]
323323

324-
ifdef::virt-installing-configuring-oadp[]
324+
ifdef::installing-oadp-kubevirt,virt-installing-configuring-oadp[]
325325
+
326326
[source,yaml,subs="attributes+"]
327327
----

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
// * backup_and_restore/application_backup_and_restore/configuring-oadp.adoc
44
// * virt/backup_restore/virt-installing-configuring-oadp.adoc
55
// * backup_and_restore/application_backup_and_restore/oadp-aws-sts/oadp-aws-sts.adoc
6+
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
7+
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
8+
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
9+
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
10+
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
611

712
:_mod-docs-content-type: PROCEDURE
813
[id="oadp-setting-resource-limits-and-requests_{context}"]

0 commit comments

Comments
 (0)