Skip to content

Mod docs for Virt #95330

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Mod docs for Virt #95330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 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
Expand Up @@ -10,6 +10,7 @@ include::_attributes/common-attributes.adoc[]

toc::[]

[role="_abstract"]
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.

Back up and restore virtual machines by using the xref:../../../backup_and_restore/index.adoc#application-backup-restore-operations-overview[{oadp-full}].
Expand Down
1 change: 1 addition & 0 deletions modules/install-and-configure-oadp-kubevirt.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="install-and-configure-oadp-kubevirt_{context}"]
= Installing and configuring {oadp-short} with {VirtProductName}

[role="_abstract"]
As a cluster administrator, you install {oadp-short} by installing the {oadp-short} Operator.

The latest version of the {oadp-short} Operator installs link:https://velero.io/docs/v{velero-version}[Velero {velero-version}].
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-backup-single-vm.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[id="oadp-backup-single-vm_{context}"]
= Backing up a single VM

[role="_abstract"]
If you have a namespace with multiple virtual machines (VMs), and want to back up only one of them, you can use the label selector to filter the VM that needs to be included in the backup. You can filter the VM by using the `app: vmname` label.


Expand Down
1 change: 1 addition & 0 deletions modules/oadp-incremental-backup-support.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="oadp-about-incremental-backup-support_{context}"]
= About incremental back up support

[role="_abstract"]
{oadp-short} supports incremental backups of `block` and `Filesystem` persistent volumes for both containerized, and {VirtProductName} workloads. The following table summarizes the support for File System Backup (FSB), Container Storage Interface (CSI), and CSI Data Mover:

[cols="5", options="header"]
Expand Down
1 change: 1 addition & 0 deletions modules/oadp-restore-single-vm-from-multiple-vm-backup.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[id="oadp-restore-single-vm-from-multiple-vm-backup_{context}"]
= Restoring a single VM from a backup of multiple VMs

[role="_abstract"]
If you have a backup containing multiple virtual machines (VMs), and you want to restore only one VM, you can use the `LabelSelectors` section in the `Restore` CR to select the VM to restore. To ensure that the persistent volume claim (PVC) attached to the VM is correctly restored, and the restored VM is not stuck in a `Provisioning` status, use both the `app: <vm_name>` and the `kubevirt.io/created-by` labels. To match the `kubevirt.io/created-by` label, use the UID of `DataVolume` of the VM.


Expand Down
1 change: 1 addition & 0 deletions modules/oadp-restore-single-vm.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[id="oadp-restore-single-vm_{context}"]
= Restoring a single VM

[role="_abstract"]
After you have backed up a single virtual machine (VM) by using the label selector in the `Backup` custom resource (CR), you can create a `Restore` CR and point it to the backup. This restore operation restores a single VM.

.Prerequisites
Expand Down
2 changes: 2 additions & 0 deletions snippets/oadp-windows-vm-backup-fails.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
// * backup_and_restore/application_backup_and_restore/installing/installing-oadp-kubevirt.adoc

:_mod-docs-content-type: SNIPPET

[role="_abstract"]
Copy link
Contributor

Choose a reason for hiding this comment

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

The role="_abstract"] tag is also needed for a snippet?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, the vale package throws an error. It says you need the tag for the para to convert to a . Thanks for the review! Appreciate the help!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, not an error, but a suggestion.

[WARNING]
====
If you run a backup of a Microsoft Windows virtual machine (VM) immediately after the VM reboots, the backup might fail with a `PartiallyFailed` error. This is because, immediately after a VM boots, the Microsoft Windows Volume Shadow Copy Service (VSS) and Guest Agent (GA) service are not ready. The VSS and GA service being unready causes the backup to fail. In such a case, retry the backup a few minutes after the VM boots.
Expand Down