New assembly and modules for CNV-1616 Editing VMs

cnv/cnv_users_guide/cnv-edit-vms.adoc

@@ -0,0 +1,15 @@
+[id="cnv-edit-vms"]
+= Editing virtual machines
+include::modules/cnv_document_attributes.adoc[]
+:context: cnv-edit-vms
+toc::[]
+
+Edit a virtual machine by completing one of the following tasks:
+
+* Using the web console
+* Editing the virtual machine YAML configuration
+* Using the CLI
+
+include::modules/cnv-editing-vm-web.adoc[leveloffset=+1]
+include::modules/cnv-editing-vm-yaml-web.adoc[leveloffset=+1]
+include::modules/cnv-editing-vm-cli.adoc[leveloffset=+1]

modules/cnv-editing-vm-cli.adoc

@@ -0,0 +1,31 @@
+// Module included in the following assemblies:
+//
+// * cnv/cnv_users_guide/cnv-edit-vms.adoc
+
+[id="cnv-editing-vm-cli_{context}"]
+= Using the CLI to edit a virtual machine
+
+.Prerequisites
+
+* You configured your virtual machine with a YAML object configuration file.
+* You installed the oc CLI.
+
+.Procedure
+
+. Run the following command to update the virtual machine configuration.
++
+[source]
+----
+oc edit
+----
++
+. Open the object configuration.
+. Edit the YAML.
+. If you edit a running virtual machine, you need to do one of the following:
+* Restart the virtual machine
+* Run the following command for the new configuration to take effect.
++
+[source]
+----
+oc apply
+----

modules/cnv-editing-vm-web.adoc

@@ -0,0 +1,26 @@
+// Module included in the following assemblies:
+//
+// * cnv/cnv_users_guide/cnv-edit-vms.adoc
+
+[id="cnv-editing-vm-web_{context}"]
+
+= Using the web console to edit a virtual machine
+
+Edit select values of a virtual machine in the web console or from the *Virtual Machine Overview* screen. Other values can be edited using the CLI.
+
+.Prerequisites
+
+* 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/cnv_users_guide/cnv-edit-vms.adoc
+
+[id="cnv-editing-vm-yaml-web_{context}"]
+
+= Editing the virtual machine YAML configuration
+
+Edit the YAML configuration of a virtual machine 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 and includes the updated version number for the object.