Merge pull request openshift#84976 from aspauldi/CNV-48752

ousleyp · web-flow · commit 147bac626543 · 2024-12-09T16:27:17.000-05:00
CNV#48752: (ContentX) Changes in and additions to Creating a VM TOC structure
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -4496,15 +4496,22 @@ Topics:
 - Name: Virtual machines
   Dir: virtual_machines
   Topics:
-  - Name: Creating VMs from Red Hat images
-    Dir: creating_vms_rh
+  - Name: Creating a virtual machine
+    Dir: creating_vm
     Topics:
-    - Name: Creating VMs from Red Hat images overview
-      File: virt-creating-vms-from-rh-images-overview
+ #   - Name: Overview
+ #     File: virt-basic-vm-overview
+ #   - Name: Setting up your environment
+ #     File: virt-setting-up-environment
     - Name: Creating VMs from instance types
       File: virt-creating-vms-from-instance-types
     - Name: Creating VMs from templates
       File: virt-creating-vms-from-templates
+  - Name: Creating VMs from Red Hat images
+    Dir: creating_vms_rh
+    Topics:
+    - Name: Creating VMs from Red Hat images overview
+      File: virt-creating-vms-from-rh-images-overview
     - Name: Creating VMs from the CLI
       File: virt-creating-vms-from-cli
   - Name: Creating VMs from custom images
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -1513,15 +1513,23 @@ Topics:
 # - Name: Virtual machines
 #   Dir: virtual_machines
 #   Topics:
+#   - Name: Creating a virtual machine
+#     Dir: creating_vm
+#     Topics:
+#     - Name: Overview
+#       File: virt-vm-overview
+#     - Name: Setting up your environment
+#       File: virt-setting-up-environment
+#     - Name: Creating VMs from instance types
+#       File: virt-creating-vms-from-instance-types
+#     - Name: Creating VMs from templates
+#       File: virt-creating-vms-from-templates
+# Topics:
 #   - Name: Creating VMs from Red Hat images
 #     Dir: creating_vms_rh
 #     Topics:
 #     - Name: Creating VMs from Red Hat images overview
 #       File: virt-creating-vms-from-rh-images-overview
-#     - Name: Creating VMs from templates
-#       File: virt-creating-vms-from-templates
-#     - Name: Creating VMs from instance types
-#       File: virt-creating-vms-from-instance-types
 #     - Name: Creating VMs from the CLI
 #       File: virt-creating-vms-from-cli
 #   - Name: Creating VMs from custom images
diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -1802,15 +1802,22 @@ Topics:
 - Name: Virtual machines
   Dir: virtual_machines
   Topics:
+  - Name: Creating a virtual machine
+    Dir: creating_vm
+    Topics:
+ #   - Name: Overview
+ #     File: virt-basic-vm-overview
+ #   - Name: Setting up your environment
+ #     File: virt-setting-up-environment
+    - Name: Creating VMs from instance types
+      File: virt-creating-vms-from-instance-types
+    - Name: Creating VMs from templates
+      File: virt-creating-vms-from-templates
   - Name: Creating VMs from Red Hat images
     Dir: creating_vms_rh
     Topics:
     - Name: Creating VMs from Red Hat images overview
       File: virt-creating-vms-from-rh-images-overview
-    - Name: Creating VMs from templates
-      File: virt-creating-vms-from-templates
-    - Name: Creating VMs from instance types
-      File: virt-creating-vms-from-instance-types
     - Name: Creating VMs from the CLI
       File: virt-creating-vms-from-cli
   - Name: Creating VMs from custom images
diff --git a/modules/virt-about-instance-types.adoc b/modules/virt-about-instance-types.adoc
@@ -1,16 +1,16 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.adoc
+// * virt/virtual_machines/creating_vm/virt-creating-vms-from-instance-types.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="virt-about-instance-types_{context}"]
 = About instance types
 
-An instance type is a reusable object where you can define resources and characteristics to apply to new VMs. You can define custom instance types or use the variety that are included when you install {VirtProductName}. 
+An instance type is a reusable object where you can define resources and characteristics to apply to new VMs. You can define custom instance types or use the variety that are included when you install {VirtProductName}.
 
 To create a new instance type, you must first create a manifest, either manually or by using the `virtctl` CLI tool. You then create the instance type object by applying the manifest to your cluster.
 
-{VirtProductName} provides two CRDs for configuring instance types: 
+{VirtProductName} provides two CRDs for configuring instance types:
 
 * A namespaced object: `VirtualMachineInstancetype`
 * A cluster-wide object: `VirtualMachineClusterInstancetype`
@@ -20,11 +20,11 @@ These objects use the same `VirtualMachineInstancetypeSpec`.
 [id="required-attributes_{context}"]
 == Required attributes
 
-When you configure an instance type, you must define the `cpu` and `memory` attributes. Other attributes are optional. 
+When you configure an instance type, you must define the `cpu` and `memory` attributes. Other attributes are optional.
 
 [NOTE]
 ====
-When you create a VM from an instance type, you cannot override any parameters defined in the instance type. 
+When you create a VM from an instance type, you cannot override any parameters defined in the instance type.
 
 Because instance types require defined CPU and memory attributes, {VirtProductName} always rejects additional requests for these resources when creating a VM from an instance type.
 ====
@@ -55,7 +55,7 @@ You can create an instance type manifest by using the `virtctl` CLI utility. For
 $ virtctl create instancetype --cpu 2 --memory 256Mi
 ----
 
-where: 
+where:
 
 `--cpu <value>`:: Specifies the number of vCPUs to allocate to the guest. Required.
 `--memory <value>`:: Specifies an amount of memory to allocate to the guest. Required.
diff --git a/modules/virt-cloud-init-fields-web.adoc b/modules/virt-cloud-init-fields-web.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-templates.adoc
+// * virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc
 
 [id="virt-cloud-init-fields-web_{context}"]
 = Cloud-init fields
diff --git a/modules/virt-common-instancetypes.adoc b/modules/virt-common-instancetypes.adoc
@@ -1,10 +1,10 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.adoc
+// * virt/virtual_machines/creating_vm/virt-creating-vms-from-instance-types.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="virt-common-instancetypes_{context}"]
-= Pre-defined instance types 
+= Pre-defined instance types
 
 {VirtProductName} includes a set of pre-defined instance types called `common-instancetypes`. Some are specialized for specific workloads and others are workload-agnostic.
 
@@ -17,17 +17,17 @@ These instance type resources are named according to their series, version, and
 ^.^|Use case ^.^|Series ^.^|Characteristics ^.^|vCPU to memory ratio ^.^|Example resource
 
 ^.^|Universal
-^.^|U 
-a| 
+^.^|U
+a|
 * Burstable CPU performance
 ^.^|1:4
-.^a|`u1.medium`:: 
+.^a|`u1.medium`::
 * 1 vCPUs
 * 4 Gi memory
 
 ^.^|Overcommitted
 ^.^|O
-a| 
+a|
 * Overcommitted memory
 * Burstable CPU performance
 ^.^|1:4
@@ -37,7 +37,7 @@ a|
 
 ^.^|Compute-exclusive
 ^.^|CX
-a| 
+a|
 * Hugepages
 * Dedicated CPU
 * Isolated emulator threads
@@ -59,8 +59,8 @@ a|
 * 128Gi memory
 
 ^.^|Memory-intensive
-^.^|M 
-a| 
+^.^|M
+a|
 * Hugepages
 * Burstable CPU performance
 ^.^|1:8
@@ -70,7 +70,7 @@ a|
 
 ^.^|Network-intensive
 ^.^|N
-a| 
+a|
 * Hugepages
 * Dedicated CPU
 * Isolated emulator threads
diff --git a/modules/virt-creating-template.adoc b/modules/virt-creating-template.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-templates.adoc
+// * virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="virt-creating-template_{context}"]
diff --git a/modules/virt-creating-vm-from-template.adoc b/modules/virt-creating-vm-from-template.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-templates.adoc
+// * virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="virt-creating-vm-from-template_{context}"]
diff --git a/modules/virt-creating-vm-instancetype.adoc b/modules/virt-creating-vm-instancetype.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/virt-creating-vms-from-instance-types.adoc
+// * virt/virtual_machines/creating_vm/virt-creating-vms-from-instance-types.adoc
 // * virt/virtual_machines/virt-accessing-vm-ssh.adoc
 
 ifeval::["{context}" == "virt-creating-vms-from-instance-types"]
diff --git a/modules/virt-customizing-vm-template-web.adoc b/modules/virt-customizing-vm-template-web.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-templates.adoc
+// * virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="virt-customizing-vm-template-web_{context}"]
diff --git a/modules/virt-networking-wizard-fields-web.adoc b/modules/virt-networking-wizard-fields-web.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-templates.adoc
+// * virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc
 // * virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc
 
 
diff --git a/modules/virt-storage-wizard-fields-web.adoc b/modules/virt-storage-wizard-fields-web.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-templates.adoc
+// * virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc
 
 [id="virt-storage-wizard-fields-web_{context}"]
 = Storage fields
diff --git a/modules/virt-vm-storage-volume-types.adoc b/modules/virt-vm-storage-volume-types.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-templates.adoc
+// * virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc
 
 [id="virt-vm-storage-volume-types_{context}"]
 = Storage volume types
diff --git a/virt/getting_started/virt-getting-started.adoc b/virt/getting_started/virt-getting-started.adoc
@@ -36,7 +36,7 @@ This short guided tour introduces several key aspects of using {VirtProductName}
 Quick start tours are available for several {VirtProductName} features. To access quick starts, complete the following steps:
 
 . Click the *Help* icon *?* in the menu bar on the header of the {product-title} web console.
-. Select *Quick Starts*. 
+. Select *Quick Starts*.
 
 You can filter the available tours by entering the keyword `virtualization` in the *Filter* field.
 endif::openshift-rosa,openshift-dedicated[]
@@ -78,7 +78,7 @@ Create a virtual machine (VM):
 * xref:../../virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-rh-images-overview.adoc#virt-creating-vms-from-rh-images-overview[Create a VM from a Red Hat image].
 ifndef::openshift-rosa,openshift-dedicated[]
 +
-You can create a VM by using a Red Hat template or an xref:../../virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[instance type].
+You can create a VM by using a Red Hat template or an xref:../../virt/virtual_machines/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[instance type].
 endif::openshift-rosa,openshift-dedicated[]
 ifdef::openshift-rosa,openshift-dedicated[]
 +
diff --git a/virt/virtual_machines/creating_vm/_attributes b/virt/virtual_machines/creating_vm/_attributes
@@ -0,0 +1 @@
+../../_attributes/
diff --git a/virt/virtual_machines/creating_vm/images b/virt/virtual_machines/creating_vm/images
@@ -0,0 +1 @@
+../../images/
diff --git a/virt/virtual_machines/creating_vm/modules b/virt/virtual_machines/creating_vm/modules
@@ -0,0 +1 @@
+../../modules/
diff --git a/virt/virtual_machines/creating_vm/snippets b/virt/virtual_machines/creating_vm/snippets
@@ -0,0 +1 @@
+../../snippets/
diff --git a/virt/virtual_machines/creating_vm/virt-basic-vm-overview.adoc b/virt/virtual_machines/creating_vm/virt-basic-vm-overview.adoc
@@ -0,0 +1,5 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="virt-basic-vm-overview"]
+= Virtual machines overview
+include::_attributes/common-attributes.adoc[]
+:context: virt-basic-vm-overview
diff --git a/virt/virtual_machines/creating_vm/virt-creating-vms-from-instance-types.adoc b/virt/virtual_machines/creating_vm/virt-creating-vms-from-instance-types.adoc
diff --git a/virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc b/virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc
@@ -0,0 +1,39 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="virt-creating-vms-from-templates"]
+= Creating virtual machines from templates
+include::_attributes/common-attributes.adoc[]
+:context: virt-creating-vms-from-templates
+
+toc::[]
+
+You can create virtual machines (VMs) from Red Hat templates by using the {product-title} web console.
+
+[id="virt-about-templates"]
+== About VM templates
+
+Boot sources::
+You can expedite VM creation by using templates that have an available boot source. Templates with a boot source are labeled *Available boot source* if they do not have a custom label.
++
+Templates without a boot source are labeled *Boot source required*. See xref:../../../virt/virtual_machines/creating_vms_custom/virt-creating-vms-from-custom-images-overview.adoc#virt-creating-vms-from-custom-images-overview[Creating virtual machines from custom images].
+
+Customization::
+You can customize the disk source and VM parameters before you start the VM.
+
+See xref:../../../virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc#virt-vm-storage-volume-types_virt-creating-vms-from-templates[storage volume types] and xref:../../../virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc#virt-storage-wizard-fields-web_virt-creating-vms-from-templates[storage fields] for details about disk source settings.
+
+
+[NOTE]
+====
+If you copy a VM template with all its labels and annotations, your version of the template is marked as deprecated when a new version of the Scheduling, Scale, and Performance (SSP) Operator is deployed. You can remove this designation. See xref:../../../virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc#virt-customizing-vm-template-web_virt-creating-vms-from-templates[Customizing a VM template by using the web console].
+====
+
+{sno-caps}::
+Due to differences in storage behavior, some templates are incompatible with {sno}. To ensure compatibility, do not set the `evictionStrategy` field for templates or VMs that use data volumes or storage profiles.
+
+include::modules/virt-creating-vm-from-template.adoc[leveloffset=+1]
+
+include::modules/virt-vm-storage-volume-types.adoc[leveloffset=+2]
+
+include::modules/virt-storage-wizard-fields-web.adoc[leveloffset=+2]
+
+include::modules/virt-customizing-vm-template-web.adoc[leveloffset=+2]
diff --git a/virt/virtual_machines/creating_vm/virt-setting-up-environment.adoc b/virt/virtual_machines/creating_vm/virt-setting-up-environment.adoc
@@ -0,0 +1,5 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="virt-setting-up-environment"]
+= Setting up your environment
+include::_attributes/common-attributes.adoc[]
+:context: virt-setting-up-environment
diff --git a/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-cli.adoc b/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-cli.adoc
@@ -6,11 +6,11 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-You can create virtual machines (VMs) from the command line by editing or creating a `VirtualMachine` manifest. You can simplify VM configuration by using an xref:../../../virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[instance type] in your VM manifest. 
+You can create virtual machines (VMs) from the command line by editing or creating a `VirtualMachine` manifest. You can simplify VM configuration by using an xref:../../../virt/virtual_machines/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[instance type] in your VM manifest.
 
 [NOTE]
 ====
-You can also xref:../../../virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.adoc#virt-creating-vm-instancetype_virt-creating-vms-from-instance-types[create VMs from instance types by using the web console].
+You can also xref:../../../virt/virtual_machines/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vm-instancetype_virt-creating-vms-from-instance-types[create VMs from instance types by using the web console].
 ====
 
 [id="creating-manifests-virtctl_{context}"]
diff --git a/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-rh-images-overview.adoc b/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-rh-images-overview.adoc
@@ -14,9 +14,9 @@ Cluster administrators can enable automatic subscription for {op-system-base-ful
 
 You can create virtual machines (VMs) from operating system images provided by Red Hat by using one of the following methods:
 
-* xref:../../../virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-templates.adoc#virt-creating-vms-from-templates[Creating a VM from a template by using the web console]
+* xref:../../../virt/virtual_machines/creating_vm/virt-creating-vms-from-templates.adoc#virt-creating-vms-from-templates[Creating a VM from a template by using the web console]
 
-* xref:../../../virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[Creating a VM from an instance type by using the web console]
+* xref:../../../virt/virtual_machines/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[Creating a VM from an instance type by using the web console]
 
 * xref:../../../virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-cli.adoc#virt-creating-vms-from-cli[Creating a VM from a `VirtualMachine` manifest by using the command line]
 
diff --git a/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-templates.adoc b/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-templates.adoc
