Skip to content

Commit 9d20b6f

Browse files
authored
Merge pull request #98269 from abrennan89/CNV-51253
CNV-51253: Clean up for DITA migration before updating docs
2 parents 05a713a + 16ccbda commit 9d20b6f

File tree

4 files changed

+52
-62
lines changed

4 files changed

+52
-62
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * /virt/backup_restore/virt-disaster-recovery.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="best-practices-rhacm-discovered-vm_{context}"]
7+
= Best practices when defining an {rh-rhacm}-discovered VM
8+
9+
You can configure any VM in the cluster that is not an {rh-rhacm}-managed application as an {rh-rhacm}-discovered application. This includes VMs imported by using the Migration Toolkit for Virtualization (MTV), VMs created by using the {product-title} web console, or VMs created by any other means, such as the CLI.
10+
11+
You can take several actions to improve your experience and chance of success when defining an {rh-rhacm}-discovered VM.
12+
13+
Protecting the VM when using MTV, the {product-title} web console, or a custom VM:: Because automatic labeling is not currently available, the application owner must manually label the components of the VM application when using MTV, the {product-title} web console, or a custom VM.
14+
+
15+
After creating the VM, apply a common label to the following resources associated with the VM: `VirtualMachine`, `DataVolume`, `PersistentVolumeClaim`, `Service`, `Route`, `Secret`, `ConfigMap`, `VirtualMachinePreference`, and `VirtualMachineInstancetype`. Do not label virtual machine instances (VMIs) or pods; {VirtProductName} creates and manages these automatically.
16+
+
17+
[IMPORTANT]
18+
====
19+
You must apply the common label to everything in the namespace that you want to protect, including objects that you added to the VM that are not listed here.
20+
====
21+
22+
Including more than the `VirtualMachine` object in the VM:: Working VMs typically also contain data volumes, persistent volume claims (PVCs), services, routes, secrets, `ConfigMap` objects, and `VirtualMachineSnapshot` objects.
23+
24+
Including the VM as part of a larger logical application:: This includes other pod-based workloads and VMs.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * /virt/backup_restore/virt-disaster-recovery.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="best-practices-rhacm-managed-vm_{context}"]
7+
= Best practices when defining an {rh-rhacm}-managed VM
8+
9+
When creating an {rh-rhacm}-managed application that includes a VM, you must use a GitOps workflow and create an {rh-rhacm} application or `ApplicationSet` resource.
10+
11+
You can take several actions to improve your experience and chance of success when defining an {rh-rhacm}-managed VM.
12+
13+
Use a PVC and populator to define storage for the VM:: Because data volumes create persistent volume claims (PVCs) implicitly, data volumes and VMs with data volume templates do not fit as neatly into the GitOps model.
14+
15+
Use the import method when choosing a population source for your VM disk:: Select a {op-system-base} image from the software catalog to use the import method. Red{nbsp}Hat recommends using a specific version of the image rather than a floating tag for consistent results. The KubeVirt community maintains container disks for other operating systems in a Quay repository.
16+
17+
Use `pullMethod: node`:: Use the pod `pullMethod: node` when creating a data volume from a registry source to take advantage of the {product-title} pull secret, which is required to pull container images from the Red{nbsp}Hat registry.

modules/virt-defining-apps-for-dr.adoc

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

virt/backup_restore/virt-disaster-recovery.adoc

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,16 @@ toc::[]
99
{VirtProductName} supports using disaster recovery (DR) solutions to ensure that your environment can recover after a site outage. To use these methods, you must plan your {VirtProductName} deployment in advance.
1010

1111
include::modules/virt-about-dr-methods.adoc[leveloffset=+1]
12-
include::modules/virt-defining-apps-for-dr.adoc[leveloffset=+1]
12+
13+
[id="virt-disaster-recovery-defining-apps_{context}"]
14+
== Defining applications for disaster recovery
15+
16+
Define applications for disaster recovery by using VMs that {rh-rhacm-first} manages or discovers.
17+
18+
include::modules/best-practices-rhacm-managed-vm.adoc[leveloffset=+2]
19+
20+
include::modules/best-practices-rhacm-discovered-vm.adoc[leveloffset=+2]
21+
1322
include::modules/virt-vm-behavior-dr.adoc[leveloffset=+1]
1423

1524
[id="dr-solutions-rh-managed-clusters_{context}"]
@@ -25,4 +34,4 @@ include::modules/virt-regional-dr-odf.adoc[leveloffset=+2]
2534
== Additional resources
2635
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/latest/html/configuring_openshift_data_foundation_disaster_recovery_for_openshift_workloads/index[Configuring {rh-storage} Disaster Recovery for OpenShift Workloads]
2736
* link:https://access.redhat.com/articles/7053115[Use {rh-storage} Disaster Recovery to Protect Virtual Machines] in the Red{nbsp}Hat Knowledgebase
28-
* link:https://docs.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10[Red{nbsp}Hat Advanced Cluster Management for Kubernetes 2.10]
37+
* link:https://docs.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10[Red{nbsp}Hat Advanced Cluster Management for Kubernetes 2.10]

0 commit comments

Comments
 (0)