Skip to content

Commit 79793e8

Browse files
ousleypousleyp
authored
Merge pull request #47753 from sabrinajess/CNV16587
CNV-16587: Updating VM wizard content to reflect new Catalog procedures
2 parents 9cecb70 + b6af54a commit 79793e8

8 files changed

+183
-129
lines changed

‎modules/virt-creating-vm-custom-template.adoc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/virtual_machines/virt-create-vms.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="virt-creating-vm-custom-template_{context}"]
7+
= Creating a virtual machine from a customized template
8+
9+
Some templates require additional parameters, for example, a PVC with a boot source. You can customize select parameters of a template to create a virtual machine (VM).
10+
11+
.Procedure
12+
13+
. In the web console, select a template:
14+
15+
.. Click *Virtualization* -> *Catalog* in the side menu.
16+
17+
.. Optional: Filter the templates by project, keyword, operating system, or workload profile.
18+
19+
.. Click the template that you want to customize.
20+
21+
. Click *Customize VirtualMachine*.
22+
23+
. Specify parameters for your VM, including its *Name* and *Disk source*. You can optionally specify a data source to clone.
24+
25+
.Verification
26+
27+
. Click *Events* to view a stream of events as the VM is provisioned.
28+
29+
. Click *Console* to verify that the VM booted successfully.

‎modules/virt-quick-creating-vm.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/virtual_machines/virt-create-vms.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="virt-quick-creating-vm_{context}"]
7+
= Quick creating a virtual machine
8+
9+
You can quickly create a virtual machine (VM) by using a template with an available boot source.
10+
11+
.Procedure
12+
13+
. Click *Virtualization* -> *Catalog* in the side menu.
14+
15+
. Click *Boot source available* to filter templates with boot sources.
16+
17+
+
18+
[NOTE]
19+
====
20+
By default, the template list will show only *Default Templates*. Click *All Items* when filtering to see all available templates for your chosen filters.
21+
====
22+
23+
. Click a template to view its details.
24+
25+
. Click *Quick Create VirtualMachine* to create a VM from the template.
26+
+
27+
The virtual machine *Details* page is displayed with the provisioning status.
28+
29+
.Verification
30+
31+
. Click *Events* to view a stream of events as the VM is provisioned.
32+
33+
. Click *Console* to verify that the VM booted successfully.

‎modules/virt-template-fields-web.adoc

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/vm_templates/virt-creating-vm-template.adoc
4+
5+
:_content-type: REFERENCE
6+
[id="virt-template-fields-web_{context}"]
7+
= Custom template fields
8+
9+
The following table lists the fields that you can edit when creating a new template in the {VirtProductName} web console:
10+
11+
|===
12+
|Name |Description
13+
14+
|Details
15+
a|
16+
* Labels
17+
* Annotations
18+
* Display name
19+
* Description
20+
* Workload profile
21+
* CPU/Memory
22+
* Boot mode
23+
* GPU devices
24+
* Host devices
25+
26+
|YAML
27+
|View the VM custom resource (CR).
28+
29+
|Scheduling
30+
a|
31+
* Node selector
32+
* Tolerations
33+
* Affinity rules
34+
* Descheduler setting
35+
* Dedicated resources
36+
* Eviction strategy
37+
38+
|Network Interfaces
39+
|Add or edit a network interface.
40+
41+
|Disks
42+
|Add or edit a disk.
43+
44+
|Scripts
45+
|Edit the `cloud-init` settings.
46+
47+
|Parameters
48+
|Edit the description and value type for the template parameters.
49+
|===

‎modules/virt-vm-fields-web.adoc

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/virtual_machines/virt-create-vms.adoc
4+
5+
// VM wizard includes additional options to VM template wizard
6+
// Call appropriate attribute in the assembly
7+
8+
:_content-type: REFERENCE
9+
[id="virt-vm-fields-web_{context}"]
10+
= Virtual machine fields
11+
12+
The following table lists the fields that you can edit when creating a new virtual machine (VM) in the {VirtProductName} web console:
13+
14+
|===
15+
|Name |Description
16+
17+
|Overview
18+
a|
19+
* Description
20+
* Operating system
21+
* CPU/Memory
22+
* Boot mode
23+
* GPU devices
24+
* Host Devices
25+
26+
|YAML
27+
|View the VM custom resource (CR).
28+
29+
|Scheduling
30+
a|
31+
* Node selector
32+
* Tolerations
33+
* Affinity rules
34+
* Dedicated resources
35+
* Eviction strategy
36+
* Descheduler setting
37+
38+
|Environment
39+
|Add a config map, secret, or service account.
40+
41+
|Network Interfaces
42+
|Add or edit a network interface.
43+
44+
|Disks
45+
|Add or edit a disk.
46+
47+
|Scripts
48+
a|
49+
* `cloud-init` settings
50+
* SSH key
51+
* Sysprep answer files
52+
53+
|Metadata
54+
|Specify labels and annotations.
55+
|===

‎modules/virt-vm-wizard-fields-web.adoc

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

‎virt/virt-learn-more-about-openshift-virtualization.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,13 @@ Cluster configuration procedures require `cluster-admin` privileges.
2424
[id="virt-getting-started"]
2525
== Getting started
2626

27-
Create a virtual machine::
28-
* Create a xref:../virt/virtual_machines/virt-create-vms.adoc#virt-creating-vm-wizard-web_virt-create-vms[RHEL virtual machine] using the wizard.
29-
* Create a Windows virtual machine:
27+
Create a virtual machine:
28+
29+
** xref:../virt/virtual_machines/virt-create-vms.adoc#virt-quick-creating-vm_virt-create-vms[Quick create] a virtual machine using the web console.
3030
** Create and customize link:https://cloud.redhat.com/blog/virtual-machines-as-code-with-openshift-gitops-and-openshift-virtualization[Windows boot sources].
31-
** Create a xref:../virt/virtual_machines/virt-create-vms.adoc#virt-creating-vm-wizard-web_virt-create-vms[Windows virtual machine] using the wizard.
32-
** Install xref:../virt/virtual_machines/virt-installing-qemu-guest-agent.adoc#virt-installing-virtio-drivers-installing-windows_virt-installing-qemu-guest-agent[VirtIO drivers and the QEMU guest agent] on the Windows virtual machine.
31+
** Install xref:../virt/virtual_machines/virt-installing-qemu-guest-agent.adoc#virt-installing-virtio-drivers-installing-windows_virt-installing-qemu-guest-agent[VirtIO drivers and the QEMU guest agent] on the virtual machine.
32+
33+
Connect to a virtual machine:
3334

3435
Connect to a virtual machine::
3536
* Connect to the xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-vm-serial-console-web_virt-accessing-vm-consoles[serial console] or xref:../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-connecting-vnc-console_virt-accessing-vm-consoles[VNC console] of a virtual machine using the web console.

‎virt/virtual_machines/virt-create-vms.adoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc::[]
99
Use one of these procedures to create a virtual machine:
1010

1111
* Quick Start guided tour
12-
* Running the wizard
12+
* Quick create from the *Catalog*
1313
* Pasting a pre-configured YAML file with the virtual machine wizard
1414
* Using the CLI
1515
@@ -30,20 +30,20 @@ Due to differences in storage behavior, some virtual machine templates are incom
3030

3131
include::modules/virt-creating-vm-quick-start-web.adoc[leveloffset=+1]
3232

33-
include::modules/virt-creating-vm-wizard-web.adoc[leveloffset=+1]
33+
include::modules/virt-quick-creating-vm.adoc[leveloffset=+1]
3434

35-
Refer to the virtual machine wizard fields section when running the web console wizard.
35+
include::modules/virt-creating-vm-custom-template.adoc[leveloffset=+1]
3636

37-
:virtualmachine:
38-
include::modules/virt-vm-wizard-fields-web.adoc[leveloffset=+2]
37+
Refer to the virtual machine fields section when creating a VM from the web console.
3938

40-
Enable the xref:../../scalability_and_performance/using-cpu-manager.adoc#using-cpu-manager[CPU Manager] to use the high-performance workload profile.
39+
:virtualmachine:
40+
include::modules/virt-vm-fields-web.adoc[leveloffset=+2]
4141

42-
include::modules/virt-networking-wizard-fields-web.adoc[leveloffset=+2]
42+
include::modules/virt-networking-wizard-fields-web.adoc[leveloffset=+3]
4343

44-
include::modules/virt-storage-wizard-fields-web.adoc[leveloffset=+2]
44+
include::modules/virt-storage-wizard-fields-web.adoc[leveloffset=+3]
4545

46-
include::modules/virt-cloud-init-fields-web.adoc[leveloffset=+2]
46+
include::modules/virt-cloud-init-fields-web.adoc[leveloffset=+3]
4747

4848
To configure storage class defaults, use storage profiles. For more information, see xref:../../virt/virtual_machines/virtual_disks/virt-creating-data-volumes.adoc#virt-customizing-storage-profile_virt-creating-data-volumes[Customizing the storage profile].
4949

@@ -69,6 +69,7 @@ include::modules/virt-about-runstrategies-vms.adoc[leveloffset=+1]
6969
The KubeVirt API Reference is the upstream project reference and might contain parameters that are not supported in {VirtProductName}.
7070
====
7171

72+
* Enable the xref:../../scalability_and_performance/using-cpu-manager.adoc#using-cpu-manager[CPU Manager] to use the high-performance workload profile.
7273
* See xref:../../virt/virtual_machines/virtual_disks/virt-using-container-disks-with-vms.adoc#virt-using-container-disks-with-vms[Prepare a container disk] before adding it to a virtual machine as a `containerDisk` volume.
7374
* See xref:../../machine_management/deploying-machine-health-checks.adoc#machine-health-checks-about_deploying-machine-health-checks[Deploying machine health checks] for further details on deploying and enabling machine health checks.
7475
* See xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[Installer-provisioned infrastructure overview] for further details on installer-provisioned infrastructure.

‎virt/vm_templates/virt-creating-vm-template.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,7 @@ The following tables describe the fields for the *General*, *Networking*,
2020
*Storage*, and *Advanced* steps in the *Create Virtual Machine Template* wizard.
2121

2222
:vmtemplate:
23-
include::modules/virt-vm-wizard-fields-web.adoc[leveloffset=+2]
24-
include::modules/virt-networking-wizard-fields-web.adoc[leveloffset=+2]
25-
include::modules/virt-storage-wizard-fields-web.adoc[leveloffset=+2]
26-
include::modules/virt-cloud-init-fields-web.adoc[leveloffset=+2]
23+
include::modules/virt-template-fields-web.adoc[leveloffset=+2]
2724
:vmtemplate!:
2825

2926
[id="additional-resources_creating-vm-template"]

0 commit comments

Comments
 (0)