Merge pull request #57755 from apinnick/general-cleanup

General cleanup

Author: apinnick

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

@@ -2,10 +2,6 @@
 //
 // * web_console/using-dashboard-to-get-cluster-information.adoc
 
-ifeval::["{context}" == "virt-using-dashboard-to-get-cluster-info"]
-:virt-cluster:
-endif::[]
-
 :_content-type: CONCEPT
 [id="virt-about-the-overview-dashboard_{context}"]
 = About the {product-title} dashboards page
@@ -23,13 +19,7 @@ Status include *ok*, *error*, *warning*, *in progress*, and *unknown*. Resources
 ** Number of nodes
 ** Number of pods
 ** Persistent storage volume claims
-ifdef::virt-cluster[]
-** Virtual machines (available if {VirtProductName} is installed)
-endif::virt-cluster[]
 ** Bare metal hosts in the cluster, listed according to their state (only available in *metal3* environment).
-ifdef::virt-cluster[]
-* *Cluster Health* summarizes the current health of the cluster as a whole, including relevant alerts and descriptions. If {VirtProductName} is installed, the overall health of {VirtProductName} is diagnosed as well. If more than one subsystem is present, click *See All* to view the status of each subsystem.
-endif::virt-cluster[]
 * *Cluster Capacity* charts help administrators understand when additional resources are required in the cluster. The charts contain an inner ring that displays current consumption, while an outer ring displays thresholds configured for the resource, including information about:
 ** CPU time
 ** Memory allocation
@@ -39,6 +29,3 @@ endif::virt-cluster[]
 * *Events* lists messages related to recent activity in the cluster, such as pod creation or virtual machine migration to another host.
 * *Top Consumers* helps administrators understand how cluster resources are consumed. Click on a resource to jump to a detailed page listing pods and nodes that consume the largest amount of the specified cluster resource (CPU, memory, or storage).
 
-ifeval::["{context}" == "virt-using-dashboard-to-get-cluster-info"]
-:!virt-cluster:
-endif::[]

modules/virt-about-vm-snapshots.adoc

@@ -22,6 +22,7 @@ With the VM snapshots feature, cluster administrators and application developers
 * Restore a VM from a snapshot
 * Delete an existing VM snapshot
 
+[id="vm-snapshot-controller-and-crds_{context}"]
 == Virtual machine snapshot controller and custom resource definitions (CRDs)
 
 The VM snapshot feature introduces three new API objects defined as CRDs for managing snapshots:

modules/virt-creating-blank-disk-datavolumes.adoc

@@ -18,7 +18,6 @@ customizing and deploying a data volume configuration file.
 
 . Edit the `DataVolume` manifest:
 +
-
 [source,yaml]
 ----
 apiVersion: cdi.kubevirt.io/v1beta1
@@ -29,18 +28,17 @@ spec:
   source:
       blank: {}
   pvc:
-    # Optional: Set the storage class or omit to accept the default
-    # storageClassName: "hostpath"
+    storageClassName: "hostpath" <1>
     accessModes:
       - ReadWriteOnce
     resources:
       requests:
         storage: 500Mi
 ----
+<1> Optional: If you do not specify a storage class, the default storage class is applied.
 
 . Create the blank disk image by running the following command:
 +
-
 [source,terminal]
 ----
 $ oc create -f <blank-image-datavolume>.yaml

modules/virt-creating-bridge-nad-web.adoc

@@ -7,11 +7,13 @@
 [id="virt-creating-linux-bridge-nad-web_{context}"]
 = Creating a Linux bridge network attachment definition in the web console
 
-Network administrators can create network attachment definitions to provide layer-2 networking to pods and virtual machines.
+You can create network attachment definitions to provide layer-2 networking to pods and virtual machines.
+
+A Linux bridge network attachment definition is the most efficient method for connecting a virtual machine to a VLAN.
 
 .Procedure
 
-. In the web console, click *Networking* -> *Network Attachment Definitions*.
+. In the web console, click *Networking* -> *NetworkAttachmentDefinitions*.
 . Click *Create Network Attachment Definition*.
 +
 [NOTE]
@@ -20,13 +22,8 @@ The network attachment definition must be in the same namespace as the pod or vi
 ====
 +
 . Enter a unique *Name* and optional *Description*.
-. Click the *Network Type* list and select *CNV Linux bridge*.
+. Select *CNV Linux bridge* from the *Network Type* list.
 . Enter the name of the bridge in the *Bridge Name* field.
 . Optional: If the resource has VLAN IDs configured, enter the ID numbers in the *VLAN Tag Number* field.
 . Optional: Select *MAC Spoof Check* to enable MAC spoof filtering. This feature provides security against a MAC spoofing attack by allowing only a single MAC address to exit the pod.
-. Click *Create*.
-+
-[NOTE]
-====
-A Linux bridge network attachment definition is the most efficient method for connecting a virtual machine to a VLAN.
-====
+. Click *Create*.

modules/virt-customizing-storage-profile.adoc

@@ -9,20 +9,19 @@
 
 You can specify default parameters by editing the `StorageProfile` object for the provisioner's storage class. These default parameters only apply to the persistent volume claim (PVC) if they are not configured in the `DataVolume` object.
 
-.Prerequisites
-* Ensure that your planned configuration is supported by the storage class and its provider. Specifying an incompatible configuration in a storage profile causes volume provisioning to fail.
-
-[NOTE]
-====
 An empty `status` section in a storage profile indicates that a storage provisioner is not recognized by the Containerized Data Interface (CDI). Customizing a storage profile is necessary if you have a storage provisioner that is not recognized by the CDI. In this case, the administrator sets appropriate values in the storage profile to ensure successful allocations.
-====
 
 [WARNING]
 ====
 If you create a data volume and omit YAML attributes and these attributes are not defined in the storage profile, then the requested storage will not be allocated and the underlying persistent volume claim (PVC) will not be created.
 ====
 
+.Prerequisites
+
+* Ensure that your planned configuration is supported by the storage class and its provider. Specifying an incompatible configuration in a storage profile causes volume provisioning to fail.
+
 .Procedure
+
 . Edit the storage profile. In this example, the provisioner is not recognized by CDI:
 +
 [source,terminal]
@@ -37,7 +36,7 @@ apiVersion: cdi.kubevirt.io/v1beta1
 kind: StorageProfile
 metadata:
   name: <unknown_provisioner_class>
-#   ...
+...
 spec: {}
 status:
   provisioner: <unknown_provisioner>
@@ -53,7 +52,7 @@ apiVersion: cdi.kubevirt.io/v1beta1
 kind: StorageProfile
 metadata:
   name: <unknown_provisioner_class>
-#   ...
+...
 spec:
   claimPropertySets:
   - accessModes:
@@ -76,9 +75,9 @@ You can use storage profiles to set a default cloning method for a storage class
 
 Cloning strategies can be specified by setting the `cloneStrategy` attribute in a storage profile to one of these values:
 
-* `snapshot` - This method is used by default when snapshots are configured. This cloning strategy uses a temporary volume snapshot to clone the volume. The storage provisioner must support CSI snapshots.
-* `copy` - This method uses a source pod and a target pod to copy data from the source volume to the target volume. Host-assisted cloning is the least efficient method of cloning.
-* `csi-clone` - This method uses the CSI clone API to efficiently clone an existing volume without using an interim volume snapshot. Unlike `snapshot` or `copy`, which are used by default if no storage profile is defined, CSI volume cloning is only used when you specify it in the `StorageProfile` object for the provisioner's storage class.
+* `snapshot` is used by default when snapshots are configured. This cloning strategy uses a temporary volume snapshot to clone the volume. The storage provisioner must support Container Storage Interface (CSI) snapshots.
+* `copy` uses a source pod and a target pod to copy data from the source volume to the target volume. Host-assisted cloning is the least efficient method of cloning.
+* `csi-clone` uses the CSI clone API to efficiently clone an existing volume without using an interim volume snapshot. Unlike `snapshot` or `copy`, which are used by default if no storage profile is defined, CSI volume cloning is only used when you specify it in the `StorageProfile` object for the provisioner's storage class.
 
 [NOTE]
 ====
@@ -92,19 +91,18 @@ apiVersion: cdi.kubevirt.io/v1beta1
 kind: StorageProfile
 metadata:
   name: <provisioner_class>
-#   ...
+...
 spec:
   claimPropertySets:
   - accessModes:
     - ReadWriteOnce <1>
     volumeMode:
       Filesystem <2>
-  cloneStrategy:
-  csi-clone <3>
+  cloneStrategy: csi-clone <3>
 status:
   provisioner: <provisioner>
   storageClass: <provisioner_class>
 ----
-<1> The `accessModes` that you select.
-<2> The `volumeMode` that you select.
-<3> The default cloning method of your choice. In this example, CSI volume cloning is specified.
+<1> Specify the access mode.
+<2> Specify the volume mode.
+<3> Specify the default cloning strategy.

modules/virt-delete-vm-web.adoc

@@ -7,18 +7,16 @@
 
 = Deleting a virtual machine using the web console
 
-Deleting a virtual machine permanently removes it from the cluster. +
-[NOTE]
-====
-When you delete a virtual machine, the data volume it uses is automatically deleted.
-====
+Deleting a virtual machine permanently removes it from the cluster.
 
 .Procedure
 
 . In the {product-title} console, click *Virtualization* -> *VirtualMachines* from the side menu.
 
-. Click the Options menu {kebab} of the virtual machine that you want to delete and select *Delete*.
+. Click the Options menu {kebab} beside a virtual machine and select *Delete*.
++
+Alternatively, click the virtual machine name to open the *VirtualMachine details* page and click *Actions* -> *Delete*.
 
-** Alternatively, click the virtual machine name to open the *VirtualMachine details* page and click *Actions* -> *Delete*.
+. Optional: Select *With grace period* or clear *Delete disks*.
 
-. In the confirmation pop-up window, click *Delete* to permanently delete the virtual machine.
+. Click *Delete* to permanently delete the virtual machine.

modules/virt-deleting-vms.adoc

@@ -7,12 +7,7 @@
 
 = Deleting a virtual machine by using the CLI
 
-You can delete a virtual machine by using the `oc`        command line interface (CLI).
-The `oc` client enables you to perform actions on multiple virtual machines. +
-[NOTE]
-====
-When you delete a virtual machine, the data volume it uses is automatically deleted.
-====
+You can delete a virtual machine by using the `oc` command line interface (CLI). The `oc` client enables you to perform actions on multiple virtual machines.
 
 .Prerequisites
 
@@ -29,7 +24,7 @@ $ oc delete vm <vm_name>
 +
 [NOTE]
 ====
-This command only deletes objects that exist in the current project. Specify the
-`-n <project_name>` option if the object you want to delete is in
+This command only deletes a VM in the current project. Specify the
+`-n <project_name>` option if the VM you want to delete is in
 a different project or namespace.
 ====

modules/virt-enlarging-vm-disk.adoc

@@ -6,7 +6,7 @@
 [id="virt-enlarging-vm-disk_{context}"]
 = Enlarging a virtual machine disk
 
-VM disk enlargement makes extra space available to the virtual machine. However, it is the responsibility of the VM owner to decide how to consume the storage.
+Virtual machine (VM) disk enlargement makes extra space available to the virtual machine. However, it is the responsibility of the VM owner to decide how to consume the storage.
 
 If the disk is a `Filesystem` PVC, the matching file expands to the remaining size while reserving some space for file system overhead.
 
@@ -15,15 +15,13 @@ If the disk is a `Filesystem` PVC, the matching file expands to the remaining si
 . Edit the `PersistentVolumeClaim` manifest of the VM disk that you want to expand:
 +
 [source,terminal]
-
 ----
 $ oc edit pvc <pvc_name>
 ----
 
-. Change the value of `spec.resource.requests.storage` attribute to a larger size.
+. Update the disk size:
 +
 [source,yaml]
-
 ----
 apiVersion: v1
 kind: PersistentVolumeClaim
@@ -37,4 +35,4 @@ spec:
        storage: 3Gi <1>
 ...
 ----
-<1> The VM disk size that can be increased
+<1> Specify the new disk size.

modules/virt-example-nmstate-multiple-interfaces.adoc

@@ -11,7 +11,7 @@ The following example snippet creates a bond that is named `bond10` across two N
 
 [source,yaml]
 ----
-#...
+...
     interfaces:
     - name: bond10
       description: Bonding eth2 and eth3 for Linux bridge
@@ -28,5 +28,5 @@ The following example snippet creates a bond that is named `bond10` across two N
       bridge:
         port:
         - name: bond10
-#...
+...
 ----