diff --git a/cnv_release_notes/cnv_release_notes.adoc b/cnv_release_notes/cnv_release_notes.adoc index 2b47a49ef65b..e2ef5323bd94 100644 --- a/cnv_release_notes/cnv_release_notes.adoc +++ b/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)] + diff --git a/cnv_users_guide/cnv_users_guide.adoc b/cnv_users_guide/cnv_users_guide.adoc index dd10c132f42c..789bfc260af2 100644 --- a/cnv_users_guide/cnv_users_guide.adoc +++ b/cnv_users_guide/cnv_users_guide.adoc @@ -14,6 +14,46 @@ 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] @@ -29,9 +69,7 @@ include::modules/cnv_blankdisk_pvc.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} @@ -59,10 +97,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] diff --git a/modules/cnv_cloud_init_fields_web.adoc b/modules/cnv_cloud_init_fields_web.adoc new file mode 100644 index 000000000000..35e7f58214d3 --- /dev/null +++ b/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. +|=== + diff --git a/modules/cnv_creating_template_wizard_web.adoc b/modules/cnv_creating_template_wizard_web.adoc new file mode 100644 index 000000000000..6ae1cf6ef129 --- /dev/null +++ b/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*. + diff --git a/modules/cnv_creating_vm_wizard_web.adoc b/modules/cnv_creating_vm_wizard_web.adoc new file mode 100644 index 000000000000..19584b92c5d9 --- /dev/null +++ b/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*. + diff --git a/modules/cnv_creating_vm_yaml_web.adoc b/modules/cnv_creating_vm_yaml_web.adoc new file mode 100644 index 000000000000..419f0c6d44f2 --- /dev/null +++ b/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*. + diff --git a/modules/cnv_delete_template_web.adoc b/modules/cnv_delete_template_web.adoc new file mode 100644 index 000000000000..a08ebb76629c --- /dev/null +++ b/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. + diff --git a/modules/cnv_delete_vm_web.adoc b/modules/cnv_delete_vm_web.adoc new file mode 100644 index 000000000000..0708faa0547e --- /dev/null +++ b/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. diff --git a/modules/cnv_editing_template_yaml_web.adoc b/modules/cnv_editing_template_yaml_web.adoc new file mode 100644 index 000000000000..31b2313c58e2 --- /dev/null +++ b/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. + diff --git a/modules/cnv_editing_vm_web.adoc b/modules/cnv_editing_vm_web.adoc new file mode 100644 index 000000000000..0b6abb984f0a --- /dev/null +++ b/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. + diff --git a/modules/cnv_editing_vm_yaml_web.adoc b/modules/cnv_editing_vm_yaml_web.adoc new file mode 100644 index 000000000000..98e3c4378e28 --- /dev/null +++ b/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. + diff --git a/modules/cnv_networking_wizard_fields_web.adoc b/modules/cnv_networking_wizard_fields_web.adoc new file mode 100644 index 000000000000..74278c5cd756 --- /dev/null +++ b/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`. +|=== + + diff --git a/modules/cnv_restart_vm_web.adoc b/modules/cnv_restart_vm_web.adoc new file mode 100644 index 000000000000..e0b10d7492a2 --- /dev/null +++ b/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. + diff --git a/modules/cnv_start_vm_web.adoc b/modules/cnv_start_vm_web.adoc new file mode 100644 index 000000000000..5479cdd77d8d --- /dev/null +++ b/modules/cnv_start_vm_web.adoc @@ -0,0 +1,23 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-start-vm-web]] +== Starting a virtual machine + +Virtual machines can be xref:cnv-vm-actions-web[started] 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. + +.Procedure + +. Click *Workloads* -> *Virtual Machine* from the side menu. +. Click the ⋮ button of the virtual machine and select *Start Virtual Machine*. +.. Alternatively, click the virtual machine name to open the *Virtual Machine Details* screen and click *Actions* and select *Start Virtual Machine*. +. In the confirmation pop-up window, click *Start* to start the virtual machine. + +[NOTE] +==== +When a virtual machine 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 URL endpoint. This may take several minutes depending on the size of the image. +==== + diff --git a/modules/cnv_stop_vm_web.adoc b/modules/cnv_stop_vm_web.adoc new file mode 100644 index 000000000000..c73218d3c35d --- /dev/null +++ b/modules/cnv_stop_vm_web.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-stop-vm-web]] +== Stopping a virtual machine + +A running virtual machines can be xref:cnv-vm-actions-web[stopped] 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. + +.Procedure + +. Click *Workloads* -> *Virtual Machine* from the side menu. +. Click the ⋮ button of the virtual machine and select *Stop Virtual Machine*. +.. Alternatively, click the virtual machine name to open the *Virtual Machine Details* screen and click *Actions* and select *Stop Virtual Machine*. +. In the confirmation pop-up window, click *Stop* to stop the virtual machine. + diff --git a/modules/cnv_storage_wizard_fields_web.adoc b/modules/cnv_storage_wizard_fields_web.adoc new file mode 100644 index 000000000000..b02d3bab2ed7 --- /dev/null +++ b/modules/cnv_storage_wizard_fields_web.adoc @@ -0,0 +1,28 @@ +// Module included in the following assemblies: +//cnv_storage_wizard_fields_web.adoc +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-storage-wizard-fields-web]] +== Storage fields +|=== +|Name | Description + +|Create Disk +|Create a new disk for the virtual machine. + +|Attach Disk +|Select an existing disk, from a list of available PVCs, to attach to the virtual machine. + +|DISK NAME +|Name of the disk. + +|SIZE (GB) +|Size, in GB, of the disk. + +|STORAGE CLASS +|Name of the underlying `StorageClass`. + +|Bootable Disk +|List of available disks from which the virtual machine will boot. This is locked to `rootdisk` if the *Provision Source* of the virtual machine is `URL` or `Container`. +|=== + diff --git a/modules/cnv_template_wizard_fields_web.adoc b/modules/cnv_template_wizard_fields_web.adoc new file mode 100644 index 000000000000..b7d86cf67631 --- /dev/null +++ b/modules/cnv_template_wizard_fields_web.adoc @@ -0,0 +1,49 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-template-wizard-fields-web]] +== Virtual machine template wizard fields + +|=== +|Name |Parameter |Description + +|Name +| +|Name of the virtual machine template. Alphanumeric characters only, up to a maximum of 63. + +|Description +| +|Optional description field. + +.3+|Provision Source +|PXE +|Provision virtual machines from PXE menu. Requires a xref:pxebooting[PXE-capable NIC] in the cluster. + +|URL +|Provision virtual machines from an image available from a *HTTP* or *S3* endpoint. + +|Container +|Provision virtual machines from a bootable operating system container located in a registry accessible from the cluster. Example: `_kubevirt/cirros-registry-disk-demo_` + +|Operating System +| +|A list of operating systems available in the cluster. This is the primary operating system for the virtual machine. + +|Flavor +|small, medium, large, tiny, Custom +|Presets that determine the amount of CPU and memory allocated to the virtual machines. + +.2+|Workload Profile +|generic +|A general configuration that balances performance and compatibility for a broad range of workloads. + +|highperformance +|Virtual machines have a more efficient configuration optimized for high performance loads. + +|cloud-init +| +|Select this checkbox to enable the xref:cnv-cloud-init-fields-web[cloud-init fields]. +|=== + + diff --git a/modules/cnv_vm_actions_web.adoc b/modules/cnv_vm_actions_web.adoc new file mode 100644 index 000000000000..2c13e206b366 --- /dev/null +++ b/modules/cnv_vm_actions_web.adoc @@ -0,0 +1,29 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-vm-actions-web]] +== Virtual machine actions + +.Actions +|=== +|Action | Available in state | Description + +|*Start Virtual Machine* +|_Off_ +|Start the virtual machine. + +|*Stop Virtual Machine* +|_Running_ or _Other_ +|Stop the virtual machine. + +|*Restart Virtual Machine* +|_Running_ or _Other_ +|Restart the running virtual machine. + +|*Delete Virtual Machine* +|_All_ +|Permanently delete the virtual machine from the cluster. +|=== + + diff --git a/modules/cnv_vm_console_web.adoc b/modules/cnv_vm_console_web.adoc new file mode 100644 index 000000000000..e9c21b7164a4 --- /dev/null +++ b/modules/cnv_vm_console_web.adoc @@ -0,0 +1,20 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-vm-console-web]] +== Virtual machine console sessions + +You can connect to the VNC and serial consoles of a running virtual machine from the *Consoles* tab in the *Virtual Machine Details* screen of the web console. + +There are two consoles available: the graphical *VNC Console* and the *Serial Console*. The *VNC Console* opens by default whenever you navigate to the *Consoles* tab. You can switch between the consoles using the xref:cnv-vm-vnc-console-web[*VNC Console*]|xref:cnv-vm-serial-console-web[*Serial Console*] drop-down list. + +Console sessions remain active in the background unless they are disconnected. When the *Disconnect before switching* checkbox is active and you switch consoles, the current console session is disconnected and a new session with the selected console connects to the virtual machine. This ensures only one console session is open at a time. + +.Options for the *VNC Console* +The *Send Key* button lists key combinations to send to the virtual machine. + +.Options for the *Serial Console* +Use the *Disconnect* button to manually disconnect the *Serial Console* session from the virtual machine. + +Use the *Reconnect* button to manually open a *Serial Console* session to the virtual machine. + diff --git a/modules/cnv_vm_create_disk_web.adoc b/modules/cnv_vm_create_disk_web.adoc new file mode 100644 index 000000000000..cb6d7f26c51a --- /dev/null +++ b/modules/cnv_vm_create_disk_web.adoc @@ -0,0 +1,19 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-vm-create-disk-web]] +== Creating a disk for a virtual machine + +Create and attach additional storage disks to a virtual machine from the web console. + +.Procedure + +. Click *Workloads* -> *Virtual Machines* from the side menu. +. Select a virtual machine. +. Click *Disks* to display the disks already attached to the virtual machine. +. Click *Create Disk* to create a new slot in the list. +. Fill in the *NAME*, *SIZE*, and optional *STORAGE CLASS* xref:cnv-storage-wizard-fields-web[details] for the new disk. +. Click the ✓ button to save and attach the disk to the virtual machine. + + diff --git a/modules/cnv_vm_create_nic_web.adoc b/modules/cnv_vm_create_nic_web.adoc new file mode 100644 index 000000000000..26796c1f36d6 --- /dev/null +++ b/modules/cnv_vm_create_nic_web.adoc @@ -0,0 +1,19 @@ + +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-vm-create-nic-web]] +== Creating a NIC for a virtual machine + +Create and attach additional NICs to a virtual machine from the web console. + +.Procedure + +. Click *Workloads* -> *Virtual Machines* from the side menu. +. Select a virtual machine template. +. Click *Network Interfaces* to display the NICs already attached to the virtual machine. +. Click *Create NIC* to create a new slot in the list. +. Fill in the *NAME*, *NETWORK*, and *MAC ADDRESS* xref:cnv-networking-wizard-fields-web[details] for the new NIC. +. Click the ✓ button to save and attach the NIC to the virtual machine. + diff --git a/modules/cnv_vm_delete_disk_web.adoc b/modules/cnv_vm_delete_disk_web.adoc new file mode 100644 index 000000000000..8521aa0ddd41 --- /dev/null +++ b/modules/cnv_vm_delete_disk_web.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-vm-delete-disk-web]] +== Deleting a disk from a virtual machine + +Deleting a disk from a virtual machine detaches and permanently deletes the disk. + +.Procedure + +. Click *Workloads* -> *Virtual Machines* from the side menu. +. Select a virtual machine. +. Click *Disks* to display the disks already attached to the virtual machine. +. Click the ⋮ button of the disk you wish to delete and select *Delete*. +. Click *Confirm* to detach and delete the disk. + + diff --git a/modules/cnv_vm_delete_nic_web.adoc b/modules/cnv_vm_delete_nic_web.adoc new file mode 100644 index 000000000000..9e6e371730de --- /dev/null +++ b/modules/cnv_vm_delete_nic_web.adoc @@ -0,0 +1,17 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-vm-delete-nic-web]] +== Deleting a NIC from a virtual machine + +Deleting a NIC from a virtual machine detaches and permanently deletes the NIC. + +.Procedure + +. Click *Workloads* -> *Virtual Machines* from the side menu. +. Select a virtual machine. +. Click *Network Interfaces* to display the NICs already attached to the virtual machine. +. Click the ⋮ button of the NIC you wish to delete and select *Delete*. +. In the confirmation pop-up window, click *Delete* to detach and delete the NIC. + diff --git a/modules/cnv_vm_events_web.adoc b/modules/cnv_vm_events_web.adoc new file mode 100644 index 000000000000..059c6a77730b --- /dev/null +++ b/modules/cnv_vm_events_web.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-vm-events-web]] +== Viewing the events of a virtual machine + +You can view the stream events for a running a virtual machine from the *Virtual Machine Details* screen of the web console. + +The ▮▮ button pauses the events stream. + +The ▶ button continues a paused events stream. + +.Procedure + +. Click *Workloads* -> *Virtual Machines* from the side menu. +. Select a Virtual Machine. +. Click *Events* to view all events for the virtual machine. + diff --git a/modules/cnv_vm_serial_console_web.adoc b/modules/cnv_vm_serial_console_web.adoc new file mode 100644 index 000000000000..011e7755f5c5 --- /dev/null +++ b/modules/cnv_vm_serial_console_web.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-vm-serial-console-web]] +== Connecting to the serial console + +Connect to the *Serial Console* of a running virtual machine from the *Consoles* tab in the *Virtual Machine Details* screen of the web console. + +.Procedure + +. Click *Workloads* -> *Virtual Machines* from the side menu. +. Select a virtual machine. +. Click *Consoles*. The VNC console opens by default. +. Click the *VNC Console* drop-down list and select *Serial Console*. + diff --git a/modules/cnv_vm_vnc_console_web.adoc b/modules/cnv_vm_vnc_console_web.adoc new file mode 100644 index 000000000000..7a0d95fdb311 --- /dev/null +++ b/modules/cnv_vm_vnc_console_web.adoc @@ -0,0 +1,16 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-vm-vnc-console-web]] +== Connecting to the VNC console + +Connect to the VNC console of a running virtual machine from the *Consoles* tab in the *Virtual Machine Details* screen of the web console. + +.Procedure + +. Click *Workloads* -> *Virtual Machines* from the side menu. +. Select a virtual machine. +. Click *Consoles*. The VNC console opens by default. + + diff --git a/modules/cnv_vm_wizard_fields_web.adoc b/modules/cnv_vm_wizard_fields_web.adoc new file mode 100644 index 000000000000..4e36c2df028e --- /dev/null +++ b/modules/cnv_vm_wizard_fields_web.adoc @@ -0,0 +1,56 @@ +// Module included in the following assemblies: +// +// * cnv_users_guide/cnv_users_guide.adoc + +[[cnv-vm-wizard-fields-web]] +== Virtual machine wizard fields + +|=== +|Name |Parameter |Description + +|Name +| +|Name of the virtual machine. Alphanumeric characters only, up to a maximum of 63. + +|Description +| +|Optional description field. + +|Template +| +|Template from which to create the virtual machine. Selecting a template will automatically complete other fields. + +.3+|Provision Source +|PXE +|Provision virtual machine from PXE menu. Requires a xref:pxebooting[PXE-capable NIC] in the cluster. + +|URL +|Provision virtual machine from an image available from an *HTTP* or *S3* endpoint. + +|Container +|Provision virtual machine from a bootable operating system container located in a registry accessible from the cluster. Example: `_kubevirt/cirros-registry-disk-demo_` + +|Operating System +| +|A list of operating systems available in the cluster. This is the primary operating system for the virtual machine. + +|Flavor +|small, medium, large, tiny, Custom +|Presets that determine the amount of CPU and memory allocated to the virtual machine. + +.2+|Workload Profile +|generic +|A general configuration that balances performance and compatibility for a broad range of workloads. + +|highperformance +|The virtual machine has a more efficient configuration optimized for high performance loads. + +|Start virtual machine on creation +| +|Select this checkbox to automatically start the virtual machine upon creation. + +|cloud-init +| +|Select this checkbox to enable the xref:cnv-cloud-init-fields-web[cloud-init fields]. +|=== +