Merge pull request #48480 from apinnick/CNV-20184-create-template-ui

CNV-20184: Update create/edit template procedures

Author: apinnick

_topic_maps/_topic_map.yml

@@ -3367,7 +3367,7 @@ Topics:
   Topics:
   - Name: Creating virtual machine templates
     File: virt-creating-vm-template
-  - Name: Editing a virtual machine template
+  - Name: Editing virtual machine templates
     File: virt-editing-vm-template
   - Name: Enabling dedicated resources for a virtual machine template
     File: virt-dedicated-resources-vm-template

modules/virt-about-the-vm-dashboard.adoc

@@ -7,7 +7,9 @@
 = The Virtual Machines dashboard
 
 Access virtual machines (VMs) from the {product-title} web console by navigating
-to the *Virtualization* -> *VirtualMachines* page. The *Overview* tab for each virtual machine has the following cards that display VM data:
+to the *Virtualization* -> *VirtualMachines* page and clicking a virtual machine (VM) to view the *VirtualMachine details* page.
+
+The *Overview* tab displays the following cards:
 
 * *Details* provides identifying information about the virtual machine, including:
 +

modules/virt-add-disk-to-vm.adoc

@@ -21,7 +21,7 @@ ifeval::["{context}" == "virt-editing-vm-template"]
 endif::[]
 
 :_content-type: PROCEDURE
-[id="virt-vm-add-disk_{context}"]
+[id="virt-add-disk-to-vm_{context}"]
 
 = Adding a virtual disk to a {object}
 

modules/virt-creating-template-wizard-web.adoc

@@ -0,0 +1,20 @@
+// Module included in the following assemblies:
+//
+// * virt/virtual_machines/virt-create-vms.adoc
+
+:_content-type: PROCEDURE
+[id="virt-creating-template_{context}"]
+= Creating a virtual machine template in the web console
+
+You create a virtual machine template by editing a YAML file example in the {product-title} web console.
+
+.Procedure
+
+. In the web console, click *Virtualization* -> *Templates* in the side menu.
+. Click *Create Template*.
+. Specify the template parameters by editing the YAML file.
+. Click *Create*. 
++
+The template is displayed on the *Templates* page.
+
+. Optional: Click *Download* to download and save the YAML file.

modules/virt-creating-template.adoc

@@ -16,11 +16,13 @@ endif::[]
 :_content-type: PROCEDURE
 [id="virt-editing-vm-yaml-web_{context}"]
 
-= Editing a virtual machine YAML configuration using the web console
+= Editing a {object} YAML configuration using the web console
 
-You can edit the YAML configuration of a virtual machine in the web console. Some parameters cannot be modified. If you click *Save* with an invalid configuration, an error message indicates the parameter that cannot be changed.
+You can edit the YAML configuration of a {object} in the web console. Some parameters cannot be modified. If you click *Save* with an invalid configuration, an error message indicates the parameter that cannot be changed.
 
+ifdef::virt-edit-vms[]
 If you edit the YAML configuration while the virtual machine is running, changes will not take effect until you restart the virtual machine.
+endif::[]
 
 [NOTE]
 ====
@@ -44,8 +46,9 @@ A confirmation message shows that the modification has been successful and inclu
 //Ending conditional expressions
 ifeval::["{context}" == "virt-edit-vms"]
 :object!:
+:object-gui!:
 endif::[]
-
 ifeval::["{context}" == "virt-editing-vm-template"]
 :object!:
+:object-gui!:
 endif::[]

modules/virt-editing-template-yaml-web.adoc

@@ -34,7 +34,7 @@ The following table describes the fields for *Add boot source to template* windo
 
 |Access mode
 |Access mode of the persistent volume. Supported access modes are *Single User (RWO)*, *Shared Access (RWX)*, *Read Only (ROX)*. If *Single User (RWO)* is selected, the disk can be mounted as read/write by a single node. If *Shared Access (RWX)* is selected, the disk can be mounted as read-write by many nodes. The `kubevirt-storage-class-defaults` config map provides access mode defaults for data volumes. The default value is set according to the best option for each storage class in the cluster.
-+
+
 [NOTE]
 ====
 Shared Access (RWX) is required for some features, such as live migration of virtual machines between nodes.

modules/virt-editing-vm-yaml-web.adoc

@@ -1,55 +1,126 @@
 // Module included in the following assemblies:
 //
 // * virt/virtual_machines/virt-create-vms.adoc
+// * virt/vm_templates/virt-creating-vm-template.adoc
+// * virt/vm_templates/virt-editing-vm-template.adoc
 
 // VM wizard includes additional options to VM template wizard
 // Call appropriate attribute in the assembly
 
+ifeval::["{context}" == "virt-editing-vm-template"]
+:object: virtual machine template
+:object-title: Virtual machine template
+endif::[]
+ifeval::["{context}" == "virt-edit-vms"]
+:object: virtual machine
+:object-title: Virtual machine
+endif::[]
+ifeval::["{context}" == "virt-create-vms"]
+:object: virtual machine
+:object-title: Virtual machine
+endif::[]
+
 :_content-type: REFERENCE
 [id="virt-vm-fields-web_{context}"]
-= Virtual machine fields
+= {object-title} fields
 
-The following table lists the fields that you can edit when creating a new virtual machine (VM) in the {VirtProductName} web console:
+The following table lists the {object} fields that you can edit in the {product-title} web console:
 
+[cols="1,1a", options="header"]
+.{object-title} fields
 |===
-|Name |Description
+|Tab |Fields or functionality
 
+ifdef::virtualmachine[]
 |Overview
-a|
+endif::[]
+ifdef::virt-edit-vms,virt-editing-vm-template[]
+|Details
+endif::[]
+|
+ifdef::virt-edit-vms,virt-editing-vm-template[]
+* Labels
+* Annotations
+endif::[]
+ifdef::virt-editing-vm-template[]
+* Display name
+endif::[]
 * Description
-* Operating system
+ifdef::virt-editing-vm-template[]
+* Workload profile
+endif::[]
 * CPU/Memory
 * Boot mode
+ifdef::virt-edit-vms[]
+* Boot order
+endif::[]
 * GPU devices
-* Host Devices
+* Host devices
+ifdef::virt-edit-vms[]
+* SSH access
+endif::[]
 
 |YAML
-|View the VM custom resource (CR).
+|
+* View, edit, or download the custom resource.
 
 |Scheduling
-a|
+|
 * Node selector
 * Tolerations
 * Affinity rules
 * Dedicated resources
 * Eviction strategy
 * Descheduler setting
 
+ifdef::virtualmachine[]
 |Environment
-|Add a config map, secret, or service account.
+|* Add, edit, or delete a config map, secret, or service account.
+endif::[]
 
 |Network Interfaces
-|Add or edit a network interface.
+|
+* Add, edit, or delete a network interface.
 
 |Disks
-|Add or edit a disk.
+|
+* Add, edit, or delete a disk.
 
 |Scripts
-a|
-* `cloud-init` settings
-* SSH key
+|
+* cloud-init settings
+ifdef::virtualmachine[]
+* Authorized SSH key
 * Sysprep answer files
+endif::[]
 
+ifdef::virtualmachine[]
 |Metadata
-|Specify labels and annotations.
+|
+* Labels
+* Annotations
+endif::[]
+ifdef::virt-editing-vm-template[]
+|Parameters (optional)
+|
+* Virtual machine name
+* cloud-user password
+endif::[]
+ifdef::virt-edit-vms[]
+|Snapshots
+|
+* Add, restore, or delete a virtual machine snapshot.
+endif::[]
 |===
+
+ifeval::["{context}" == "virt-editing-vm-template"]
+:virt-editing-vm-template!:
+endif::[]
+ifeval::["{context}" == "virt-edit-vms"]
+:virt-edit-vms!:
+endif::[]
+ifeval::["{context}" == "virtualmachine"]
+:virtualmachine!:
+endif::[]
+:object!:
+:object-title!: