CNV 1.4 Web UI update for VM and Templates

cnv_release_notes/cnv_release_notes.adoc

@@ -73,3 +73,9 @@ This may cause VM creation to get stuck.
 https://bugzilla.redhat.com/show_bug.cgi?id=1632255[(BZ#1632255)]
 +
 ** This will be fixed with the introduction of operators in CNV 1.4.
+
+// 1.4 Web UI
+* When a virtual machine is provisioned from a `URL` source is started for the first time, the virtual machine will be in the *Importing* state while {ProductName} imports the container from the endpoint URL. +
+Restarting a virtual machine while it is in the *Importing* state results in an error.
+https://bugzilla.redhat.com/show_bug.cgi?id=1673921[(BZ#1673921)]
+

cnv_users_guide/cnv_users_guide.adoc

@@ -11,25 +11,61 @@ include::modules/cnv_introduction_to_cnv.adoc[leveloffset=+2]
 
 [[cnv_userguide_before_begin]]
 == Before you begin
-
 include::modules/cnv_openshift_commands.adoc[leveloffset=+2]
 include::modules/cnv_virtctl_commands.adoc[leveloffset=+2]
 include::modules/cnv_ensure_correct_project.adoc[leveloffset=+2]
 
+[[cnv_userguide_vms_web]]
+== Virtual machines in the {product-title} web console
+[[cnv_userguide_managing_vms_web]]
+=== Managing virtual machines
+include::modules/cnv_creating_vm_wizard_web.adoc[leveloffset=+2]
+include::modules/cnv_creating_vm_yaml_web.adoc[leveloffset=+2]
+include::modules/cnv_editing_vm_web.adoc[leveloffset=+2]
+include::modules/cnv_editing_vm_yaml_web.adoc[leveloffset=+2]
+include::modules/cnv_vm_events_web.adoc[leveloffset=+2]
+include::modules/cnv_delete_vm_web.adoc[leveloffset=+2]
+
+[[cnv_userguide_controlling_vms_web]]
+=== Controlling virtual machines
+include::modules/cnv_start_vm_web.adoc[leveloffset=+2]
+include::modules/cnv_stop_vm_web.adoc[leveloffset=+2]
+include::modules/cnv_restart_vm_web.adoc[leveloffset=+2]
+
+[[cnv_userguide_vm_consoles_web]]
+=== Accessing virtual machine consoles
+include::modules/cnv_vm_console_web.adoc[leveloffset=+2]
+include::modules/cnv_vm_vnc_console_web.adoc[leveloffset=+2]
+include::modules/cnv_vm_serial_console_web.adoc[leveloffset=+2]
+
+[[cnv_userguide_managing_nics_web]]
+=== Managing virtual machine NICs
+include::modules/cnv_vm_create_nic_web.adoc[leveloffset=+2]
+include::modules/cnv_vm_delete_nic_web.adoc[leveloffset=+2]
+
+[[cnv_userguide_managing_disks_web]]
+=== Managing virtual machine disks
+include::modules/cnv_vm_create_disk_web.adoc[leveloffset=+2]
+include::modules/cnv_vm_delete_disk_web.adoc[leveloffset=+2]
+
+[[cnv_userguide_templates_web_console]]
+== Virtual machine templates in the {product-title} web console
+include::modules/cnv_creating_template_wizard_web.adoc[leveloffset=+2]
+include::modules/cnv_editing_template_yaml_web.adoc[leveloffset=+2]
+include::modules/cnv_delete_template_web.adoc[leveloffset=+2]
+
+
 [[cnv_userguide_importing_vms_openshift]]
 == Importing and uploading virtual machines and disk images
 include::modules/cnv_upload_virtctl.adoc[leveloffset=+2]
 include::modules/cnv_importing_vm_disk_DVs.adoc[leveloffset=+2]
 include::modules/cnv_importing_vm_disk_to_pvc.adoc[leveloffset=+2]
-include::modules/cnv_import_vm_gui.adoc[leveloffset=+2]
 include::modules/cnv_cloning_pvc_virtualmachine.adoc[leveloffset=+2]
 include::modules/cnv_cloning_pvc_datavolume.adoc[leveloffset=+2]
 
 [[cnv_userguide_creating_vms_openshift]]
 == Creating virtual machines in {product-title}
-include::modules/cnv_creating_vm_web_console.adoc[leveloffset=+2]
 include::modules/cnv_creating_vm.adoc[leveloffset=+2]
-include::modules/cnv_clone_vm_template_gui.adoc[leveloffset=+2]
 
 [[cnv_userguide_using_vms_openshift]]
 == Using virtual machines in {product-title}
@@ -57,10 +93,16 @@ include::modules/cnv_metrics.adoc[leveloffset=+2]
 
 [[cnv_userguide_reference]]
 == Reference
-include::modules/cnv_vm_storage_volume_types.adoc[leveloffset=+2]
-include::modules/cnv_template_pvc_config.adoc[leveloffset=+2]
-include::modules/cnv_template_vm_config.adoc[leveloffset=+2]
-include::modules/cnv_template_dv_config.adoc[leveloffset=+2]
-include::modules/cnv_template_import_dv.adoc[leveloffset=+2]
-include::modules/cnv_template_clone_DV.adoc[leveloffset=+2]
-include::modules/cnv_template_vmi_pxe_config.adoc[leveloffset=+2]
+include::modules/cnv_vm_wizard_fields_web.adoc[leveloffset=+2]
+include::modules/cnv_template_wizard_fields_web.adoc[leveloffset=+2]
+include::modules/cnv_cloud_init_fields_web.adoc[leveloffset=+2]
+include::modules/cnv_networking_wizard_fields_web.adoc[leveloffset=+2]
+include::modules/cnv_storage_wizard_fields_web.adoc[leveloffset=+2]
+include::modules/cnv_vm_actions_web.adoc[leveloffset=+2]
+include::modules/cnv_vm_storage_volume_types.adoc[leveloffset=+1]
+include::modules/cnv_template_pvc_config.adoc[leveloffset=+1]
+include::modules/cnv_template_vm_config.adoc[leveloffset=+1]
+include::modules/cnv_template_dv_config.adoc[leveloffset=+1]
+include::modules/cnv_template_import_dv.adoc[leveloffset=+1]
+include::modules/cnv_template_clone_DV.adoc[leveloffset=+1]
+include::modules/cnv_template_vmi_pxe_config.adoc[leveloffset=+1]

modules/cnv_cloud_init_fields_web.adoc

@@ -0,0 +1,19 @@
+// Module included in the following assemblies:
+//
+// * cnv_users_guide/cnv_users_guide.adoc
+
+[[cnv-cloud-init-fields-web]]
+== Cloud-init fields
+|===
+|Name | Description
+
+|Hostname	
+|Sets a specific hostname for the virtual machine.
+
+|Authenticated SSH Keys
+|The user's public key. This will be copied to *_~/.ssh/authorized_keys_* on the virtual machine. 
+
+|Use custom script
+|Replaces other options with a textbox into which you can paste a custom cloud-init script.
+|===
+

modules/cnv_creating_template_wizard_web.adoc

@@ -0,0 +1,35 @@
+// Module included in the following assemblies:
+//
+// * cnv_users_guide/cnv_users_guide.adoc
+
+[[cnv-creating-template-wizard-web]]
+== Creating a virtual machine template with the interactive wizard
+
+Virtual machines templates are an easy way to create multiple virtual machines with similar configuration. After a template is created, reference the template when xref:cnv-creating-vm-wizard-web[creating virtual machines].
+
+The web console features an interactive wizard that guides you through xref:cnv-template-wizard-fields-web[*Basic Settings*], xref:cnv-networking-wizard-fields-web[*Networking*], and xref:cnv-storage-wizard-fields-web[*Storage*] screens to simplify the process of creating virtual machine templates. All required fields are marked by a `*`. The wizard prevents you from moving to the next screen until the required fields have been completed.
+
+NICs and storage disks can be created and attached to virtual machines after they have been created. 
+
+.*Bootable Disk*
+
+If either `URL` or `Container` are selected as the *Provision Source* in the xref:cnv-template-wizard-fields-web[*Basic Settings*] screen, a `rootdisk` disk is created and attached to virtual machines as the *Bootable Disk*. You can modify the `rootdisk` but you cannot remove it. 
+
+A *Bootable Disk* is not required for virtual machines provisioned from a *PXE* source if there are no disks attached to the virtual machine. If one or more disks are attached to the virtual machine, you must select one as the *Bootable Disk*. 
+
+.Procedure
+
+. Click *Workloads* -> *Virtual Machine Templates* from the side menu.
+. Click *Create Template* and select *Create with Wizard*. 
+. Fill in all required xref:cnv-template-wizard-fields-web[*Basic Settings*]. 
+. Click *Next* to progress to the xref:cnv-networking-wizard-fields-web[*Networking*] screen. An `nic0` NIC is attached by default. 
+.. (Optional) Click *Create NIC* to create additional NICs. 
+.. (Optional) You can remove any or all NICs by clicking the ⋮ button and selecting *Remove NIC*. Virtual machines created from a template do not need a NIC attached. NICs can be xref:cnv-vm-create-nic-web[created] after a virtual machine has been created. 
+. Click *Next* to progress to the xref:cnv-storage-wizard-fields-web[*Storage*] screen.
+.. (Optional) Click *Create Disk* to create additional disks. These disks can be removed by clicking the ⋮ button and selecting *Remove Disk*. 
+.. (Optional) Click on a disk to modify available fields. Click the ✓ button to save the update.
+.. (Optional) Click *Attach Disk* to choose an available disk from the *Select Storage* drop-down list.
+. Click *Create Virtual Machine Template >*. The *Results* screen displays the JSON configuration file for the virtual machine template. 
+
+The template is listed in *Workloads* -> *Virtual Machine Templates*. 
+

modules/cnv_creating_vm_wizard_web.adoc

@@ -0,0 +1,34 @@
+
+// Module included in the following assemblies:
+//
+// * cnv_users_guide/cnv_users_guide.adoc
+
+[[cnv-creating-vm-wizard-web]]
+== Creating a virtual machine with the interactive wizard
+
+The web console features an interactive wizard that guides you through xref:cnv-vm-wizard-fields-web[*Basic Settings*], xref:cnv-networking-wizard-fields-web[*Networking*], and xref:cnv-storage-wizard-fields-web[*Storage*] screens to simplify the process of creating virtual machines. All required fields are marked by a `*`. The wizard prevents you from moving to the next screen until the required fields have been completed.
+
+NICs and storage disks can be created and attached to virtual machines after they have been created. 
+
+.*Bootable Disk*
+
+If either `URL` or `Container` are selected as the *Provision Source* in the xref:cnv-vm-wizard-fields-web[*Basic Settings*] screen, a `rootdisk` disk is created and attached to the virtual machine as the *Bootable Disk*. You can modify the `rootdisk` but you cannot remove it. 
+
+A *Bootable Disk* is not required for virtual machines provisioned from a *PXE* source if there are no disks attached to the virtual machine. If one or more disks are attached to the virtual machine, you must select one as the *Bootable Disk*. 
+
+.Procedure
+
+. Click *Workloads* -> *Virtual Machines* from the side menu.
+. Click *Create Virtual Machine* and select *Create with Wizard*. 
+. Fill in all required xref:cnv-vm-wizard-fields-web[*Basic Settings*]. Selecting a *Template* automatically fills in these fields. 
+. Click *Next* to progress to the xref:cnv-networking-wizard-fields-web[*Networking*] screen. A `nic0` NIC is attached by default. 
+.. (Optional) Click *Create NIC* to create additional NICs. 
+.. (Optional) You can remove any or all NICs by clicking the ⋮ button and selecting *Remove NIC*. A virtual machine does not need a NIC attached to be created. NICs can be xref:cnv-vm-create-nic-web[created] after the virtual machine has been created. 
+. Click *Next* to progress to the xref:cnv-storage-wizard-fields-web[*Storage*] screen. 
+.. (Optional) Click *Create Disk* to create additional disks. These disks can be removed by clicking the ⋮ button and selecting *Remove Disk*.
+.. (Optional) Click on a disk to modify available fields. Click the ✓ button to save the update.
+.. (Optional) Click *Attach Disk* to choose an available disk from the *Select Storage* drop-down list.
+. Click *Create Virtual Machine >*. The *Results* screen displays the JSON configuration file for the virtual machine. 
+
+The virtual machine is listed in *Workloads* -> *Virtual Machines*. 
+

modules/cnv_creating_vm_yaml_web.adoc

@@ -0,0 +1,27 @@
+// Module included in the following assemblies:
+//
+// * cnv_users_guide/cnv_users_guide.adoc
+
+[[cnv-creating-vm-yaml-web]]
+== Creating a virtual machine using a YAML configuration file
+
+Create a virtual machine by writing or pasting a YAML configuration file in the web console in the *Workloads* -> *Virtual Machines* screen. A valid `example` virtual machine configuration is provided by default whenever you open the YAML edit screen. 
+
+If your YAML configuration is invalid when you click *Create*, an error message indicates the parameter in which the error occurs. Only one error is shown at a time. 
+
+[NOTE]
+====
+Navigating away from the YAML screen while editing cancels any changes to the configuration you have made. 
+====
+
+.Procedure
+
+. Click *Workloads* -> *Virtual Machines* from the side menu.
+. Click *Create Virtual Machine* and select *Create from YAML*.
+. Write or paste your virtual machine configuration in the editable window.
+.. Alternatively, use the `example` virtual machine provided by default in the YAML screen.
+. (Optional) Click *Download* to download the YAML configuration file in its present state.
+. Click *Create* to create the virtual machine.
+
+The virtual machine is listed in *Workloads* -> *Virtual Machines*. 
+

modules/cnv_delete_template_web.adoc

@@ -0,0 +1,18 @@
+// Module included in the following assemblies:
+//
+// * cnv_users_guide/cnv_users_guide.adoc
+
+[[cnv-delete-template-web]]
+== Deleting a virtual machine template
+
+Deleting a virtual machine template permanently removes it from the cluster. 
+
+Delete a virtual machine template using the ⋮ button of the template in the *Workloads* -> *Virtual Machines Templates* list, or using the *Actions* control of the *Virtual Machine Templates Details* screen.
+
+.Procedure
+
+. Click *Workloads* -> *Virtual Machine Templates* from the side menu.
+. Click the ⋮ button of the template to delete and select *Delete Template*.
+.. Alternatively, click the template name to open the *Virtual Machine Template Details* screen and click *Actions* -> *Delete Template*. 
+. In the confirmation pop-up window, click *Delete* to permanently delete the template.
+

modules/cnv_delete_vm_web.adoc

@@ -0,0 +1,17 @@
+// Module included in the following assemblies:
+//
+// * cnv_users_guide/cnv_users_guide.adoc
+
+[[cnv-delete-vm-web]]
+== Deleting a virtual machine 
+
+Deleting a virtual machine permanently removes it from the cluster. 
+
+Delete a virtual machine using the ⋮ button of the virtual machine in the *Workloads* -> *Virtual Machines* list, or using the xref:cnv-vm-actions-web[*Actions* control] of the *Virtual Machine Details* screen.
+
+.Procedure
+
+. Click *Workloads* -> *Virtual Machines* from the side menu.
+. Click the ⋮ button of the virtual machine to delete and select *Delete Virtual Machine*.
+.. Alternatively, click the virtual machine name to open the *Virtual Machine Details* screen and click *Actions* -> *Delete Virtual Machine*. 
+. In the confirmation pop-up window, click *Delete* to permanently delete the virtual machine.

modules/cnv_editing_template_yaml_web.adoc

@@ -0,0 +1,26 @@
+// Module included in the following assemblies:
+//
+// * cnv_users_guide/cnv_users_guide.adoc
+
+[[cnv-editing-template-yaml-web]]
+== Editing the YAML of a virtual machine template
+
+You can edit the YAML configuration of a virtual machine template directly within the web console. 
+
+Not all parameters can be updated. If you edit values that cannot be changed and click *Save*, an error message shows, indicating the parameter that was not able to be updated.
+
+[NOTE]
+====
+Navigating away from the YAML screen while editing cancels any changes to the configuration you have made. 
+====
+
+.Procedure
+
+. Click *Workloads* -> *Virtual Machine Template* from the side menu.
+. Select a template.
+. Click the *YAML* tab to display the editable configuration. 
+.. (Optional) You can click *Download* to download the YAML file locally in its current state.
+. Edit the file and click *Save*. 
+
+A confirmation message shows the modification has been successful, including the updated version number for the object. 
+

modules/cnv_editing_vm_web.adoc

@@ -0,0 +1,21 @@
+// Module included in the following assemblies:
+//
+// * cnv_users_guide/cnv_users_guide.adoc
+
+[[cnv-editing-vm-web]]
+== Editing a virtual machine 
+
+You can edit some values of a virtual machine in the web console, either by editing the xref:cnv-editing-vm-yaml-web[YAML directly], or from the *Virtual Machine Overview* screen.
+
+When editing from the *Virtual Machine Overview* screen, the virtual machine must be *Off*.
+
+.Procedure
+
+. Click *Workloads* -> *Virtual Machines* from the side menu.
+. Select a Virtual Machine.
+. Click *Edit* to make editable fields available. 
+. You can change the *Flavor* but only to *Custom*, which provides additional fields for *CPU* and *Memory*. 
+. Click *Save*. 
+
+The updated values are shown after the operation is processed. 
+

modules/cnv_editing_vm_yaml_web.adoc

@@ -0,0 +1,28 @@
+// Module included in the following assemblies:
+//
+// * cnv_users_guide/cnv_users_guide.adoc
+
+[[cnv-editing-vm-yaml-web]]
+== Editing the YAML of a virtual machine
+
+You can edit the YAML configuration of a virtual machine directly within the web console. 
+
+Not all parameters can be updated. If you edit values that cannot be changed and click *Save*, an error message indicates the parameter that was not able to be updated.
+
+The YAML configuration can be edited while the virtual machine is *Running*, however the changes will only take effect after the virtual machine has been stopped and started again.
+
+[NOTE]
+====
+Navigating away from the YAML screen while editing cancels any changes to the configuration you have made. 
+====
+
+.Procedure
+
+. Click *Workloads* -> *Virtual Machine* from the side menu.
+. Select a virtual machine.
+. Click the *YAML* tab to display the editable configuration.
+.. (Optional) You can click *Download* to download the YAML file locally in its current state.
+. Edit the file and click *Save*. 
+
+A confirmation message shows that the modification has been successful, including the updated version number for the object. 
+

modules/cnv_networking_wizard_fields_web.adoc

@@ -0,0 +1,26 @@
+// Module included in the following assemblies:
+//
+// * cnv_users_guide/cnv_users_guide.adoc
+
+[[cnv-networking-wizard-fields-web]]
+== Networking fields
+|===
+|Name | Description
+
+|Create NIC
+|Create a new NIC for the virtual machine.
+
+|NIC NAME
+|Name for the NIC.
+
+|MAC ADDRESS
+|MAC address for the network interface. If a MAC address is not specified, an ephemeral address is generated for the session. 
+
+|NETWORK CONFIGURATION
+|List of available *NetworkAttachmentDefinition* objects.
+
+|PXE NIC
+|List of PXE-capable networks. Only visible if `PXE` has been selected as the `Provision Source`.
+|===
+
+

modules/cnv_restart_vm_web.adoc

@@ -0,0 +1,23 @@
+// Module included in the following assemblies:
+//
+// * cnv_users_guide/cnv_users_guide.adoc
+
+[[cnv-restart-vm-web]]
+== Restarting a virtual machine
+
+A running virtual machines can be xref:cnv-vm-actions-web[restarted] using the ⋮ button of each virtual machine in the *Workloads* -> *Virtual Machines* list. 
+
+These same control operations can be done using the xref:cnv-vm-actions-web[*Actions* control] of the *Virtual Machine Details* screen.
+
+[IMPORTANT]
+====
+Do not restart a virtual machine while it has a status of *Importing*. This will result in an error for the virtual machine and is a xref:../cnv_release_notes/cnv_release_notes.adoc#RN_known_issues[known issue]. 
+====
+
+.Procedure
+
+. Click *Workloads* -> *Virtual Machine* from the side menu.
+. Click the ⋮ button of the virtual machine and select *Restart Virtual Machine*.
+.. Alternatively, click the virtual machine name to open the *Virtual Machine Details* screen and click *Actions* and select *Restart Virtual Machine*. 
+. In the confirmation pop-up window, click *Restart* to restart the virtual machine.
+