Skip to content

OADP-3399: Reworking OpenShift KubeVirt OADP docs #72372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

OADP-3399: Reworking OpenShift KubeVirt OADP docs #72372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d550aea
updating
anarnold97 Apr 19, 2024
bc5e5d0
Update backup_and_restore/application_backup_and_restore/installing/i…
anarnold97 Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _topic_maps/_topic_map.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3078,6 +3078,8 @@ Topics:
File: installing-oadp-mcg
- Name: Configuring OADP with ODF
File: installing-oadp-ocs
- Name: Configuring OADP with OpenShift Virtualization
File: installing-oadp-kubevirt
- Name: Uninstalling OADP
Dir: installing
Topics:
Expand Down
4 changes: 4 additions & 0 deletions ..._and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,8 @@ 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]

[role="_additional-resources"]
.Additional resources
* 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]

:!installing-oadp-aws:
5 changes: 5 additions & 0 deletions ...nd_restore/application_backup_and_restore/installing/installing-oadp-azure.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,9 @@ 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]

[role="_additional-resources"]
.Additional resources

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

:installing-oadp-azure!:
4 changes: 4 additions & 0 deletions ..._and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,8 @@ include::modules/oadp-gcp-wif-cloud-authentication.adoc[leveloffset=+1]
include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources
* 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]

:installing-oadp-gcp!:
58 changes: 58 additions & 0 deletions ...restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
:_mod-docs-content-type: ASSEMBLY
[id="installing-oadp-kubevirt"]
// If docs team approves the name, "Configuring OADP with Kubevirt" great but I suspect it will need to be "Configuring OADP with OpenShift Virtualization" or "Configuring OADP with Virtualization" or perhaps... bear with me.. "OADP and OpenShift-Virtualization"
= Configuring the {oadp-full} with {VirtProductName}
include::_attributes/common-attributes.adoc[]
:context: installing-oadp-kubevirt
:installing-oadp-kubevirt:
:credentials: cloud-credentials
:provider: kubevirt

toc::[]

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.

// include::snippets/oadp-mtc-operator.adoc[]

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

[NOTE]
====
{oadp-full} with {VirtProductName} supports the following backup and restore storage options:

* 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 backups and restores

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].
====
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.

include::modules/install-and-configure-oadp-kubevirt.adoc[leveloffset=+1]

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

include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]

[IMPORTANT]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is important, why is it the last thing in the assembly? If it is something that a reader needs to know about this process, hoist it up.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 Max. A support statement is important and lobbing it at the bottom could lead customers down a path they can't actually take in the end.

.{oadp-short} 1.2
====
Red Hat only supports the combination of {oadp-short} versions 1.3.0 and later, and {VirtProductName} versions 4.14 and later.

{oadp-short} versions before 1.3.0 are not supported for back up and restore of {VirtProductName}.
====


:!installing-oadp-kubevirt:
6 changes: 6 additions & 0 deletions ..._and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,14 @@ 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]


[discrete]
[role="_additional-resources"]
.Additional resources
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a global comment because I see this in a few places, but the .Additional resources sections should only contain text inside the xref:...[only text here]. In Customer Portal, the other text doesn't render properly. See this for more info: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#additional-resources-sections

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the "see" construction for a list doesn't follow IBMSG recommendations for lead-in wording: https://www.ibm.com/docs/en/ibm-style?topic=format-lists#lead-in-wording


* link:https://access.redhat.com/solutions/6719951[Performance tuning guide for Multicloud Object Gateway].

* 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]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this xref supposed to be like the one on the file that follows @ line 52? If so, the same comment applies about having the plugin link on a separate line.


:installing-oadp-mcg!:

7 changes: 7 additions & 0 deletions ..._and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,12 @@ include::modules/oadp-installing-dpa-1-3.adoc[leveloffset=+1]
include::modules/oadp-creating-object-bucket-claim.adoc[leveloffset=+2]
include::modules/oadp-enabling-csi-dpa.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* 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]
* xref:../../../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-plugins_oadp-features-plugins[plugins].


:installing-oadp-ocs!:

36 changes: 36 additions & 0 deletions modules/install-and-configure-oadp-kubevirt.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc

:_mod-docs-content-type: PROCEDURE
[id="install-and-configure-oadp-kubevirt_{context}"]
= Installing and configuring {oadp-short} with {VirtProductName}

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}].

.Prerequisites

* Access to the cluster as a user with the `cluster-admin` role.

.Procedure

. Install the {oadp-short} Operator according to the instructions for your storage provider.

. Install the Data Protection Application (DPA)] with the `kubevirt` and `openshift` {oadp-short} plugins.

. Back up virtual machines by creating a `Backup` custom resource (CR).

+
[WARNING]
====
Red Hat support is limited to only the following options:

* CSI backups

* CSI backups with DataMover.
====

You restore the `Backup` CR by creating a `Restore` CR.

5 changes: 3 additions & 2 deletions modules/oadp-installing-dpa-1-3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
// * 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

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

ifdef::virt-installing-configuring-oadp[]
ifdef::installing-oadp-kubevirt,virt-installing-configuring-oadp[]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you provide the other preview link to compare for this ifdef?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://72372--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/backup_restore/virt-installing-configuring-oadp#oadp-installing-dpa-1-3_virt-installing-configuring-oadp

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

+
[source,yaml,subs="attributes+"]
----
Expand Down Expand Up @@ -371,6 +371,7 @@ spec:
<14> Specify a prefix for Velero backups, for example, `velero`, if the bucket is used for multiple purposes.
endif::[]


. Click *Create*.

.Verification
Expand Down
5 changes: 5 additions & 0 deletions modules/oadp-setting-resource-limits-and-requests.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
// * 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
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-gcp.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-mcg.adoc
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc

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