diff --git a/modules/virt-checking-cluster-dpdk-readiness.adoc b/modules/virt-checking-cluster-dpdk-readiness.adoc index 9b215ad499..fda83ee61b 100644 --- a/modules/virt-checking-cluster-dpdk-readiness.adoc +++ b/modules/virt-checking-cluster-dpdk-readiness.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="virt-checking-cluster-dpdk-readiness_{context}"] -= DPDK checkup += Running a DPDK checkup by using the command line Use a predefined checkup to verify that your {product-title} cluster node can run a virtual machine (VM) with a Data Plane Development Kit (DPDK) workload with zero packet loss. The DPDK checkup runs traffic between a traffic generator and a VM running a test DPDK application. diff --git a/modules/virt-checking-storage-configuration.adoc b/modules/virt-checking-storage-configuration.adoc index 7df1c13db5..90a76b026a 100644 --- a/modules/virt-checking-storage-configuration.adoc +++ b/modules/virt-checking-storage-configuration.adoc @@ -4,11 +4,10 @@ :_mod-docs-content-type: PROCEDURE [id="virt-checking-storage-configuration_{context}"] -= Running a storage checkup += Running a storage checkup by using the command line Use a predefined checkup to verify that the {product-title} cluster storage is configured optimally to run {VirtProductName} workloads. - .Prerequisites * You have installed the OpenShift CLI (`oc`). * The cluster administrator has created the required `cluster-reader` permissions for the storage checkup service account and namespace, such as in the following example: @@ -107,6 +106,8 @@ metadata: namespace: $CHECKUP_NAMESPACE data: spec.timeout: 10m + spec.param.storageClass: ocs-storagecluster-ceph-rbd-virtualization + spec.param.vmiTimeout: 3m --- apiVersion: batch/v1 kind: Job @@ -166,15 +167,17 @@ data: status.failureReason: "" # <2> status.startTimestamp: "2023-07-31T13:14:38Z" # <3> status.completionTimestamp: "2023-07-31T13:19:41Z" # <4> - status.result.cnvVersion: 4.16.2 - status.result.defaultStorageClass: trident-nfs <5> - status.result.goldenImagesNoDataSource: # <6> - status.result.goldenImagesNotUpToDate: # <7> - status.result.ocpVersion: 4.16.0 - status.result.storageMissingVolumeSnapshotClass: - status.result.storageProfilesWithEmptyClaimPropertySets: # <8> - status.result.storageProfilesWithSpecClaimPropertySets: - status.result.storageWithRWX: |- + status.result.cnvVersion: 4.16.2 # <5> + status.result.defaultStorageClass: trident-nfs <6> + status.result.goldenImagesNoDataSource: # <7> + status.result.goldenImagesNotUpToDate: # <8> + status.result.ocpVersion: 4.16.0 # <9> + status.result.pvcBound: "true" # <10> + status.result.storageProfileMissingVolumeSnapshotClass: # <11> + status.result.storageProfilesWithEmptyClaimPropertySets: # <12> + status.result.storageProfilesWithSmartClone: # <13> + status.result.storageProfilesWithSpecClaimPropertySets: # <14> + status.result.storageProfilesWithRWX: |- ocs-storagecluster-ceph-rbd ocs-storagecluster-ceph-rbd-virtualization ocs-storagecluster-cephfs @@ -188,19 +191,25 @@ data: VMI "vmi-under-test-dhkb8" hotplug volume removed status.result.vmLiveMigration: VMI "vmi-under-test-dhkb8" migration completed status.result.vmVolumeClone: 'DV cloneType: "csi-clone"' - status.result.vmsWithNonVirtRbdStorageClass: # <9> - status.result.vmsWithUnsetEfsStorageClass: # <10> + status.result.vmsWithNonVirtRbdStorageClass: # <15> + status.result.vmsWithUnsetEfsStorageClass: # <16> ---- <1> Specifies if the checkup is successful (`true`) or not (`false`). <2> The reason for failure if the checkup fails. <3> The time when the checkup started, in RFC 3339 time format. <4> The time when the checkup has completed, in RFC 3339 time format. -<5> Specifies if there is a default storage class. -<6> The list of golden images whose data source is not ready. -<7> The list of golden images whose data import cron is not up-to-date. -<8> The list of storage profiles with unknown provisioners. -<9> The list of virtual machines that use the Ceph RBD storage class when the virtualization storage class exists. -<10> The list of virtual machines that use an Elastic File Store (EFS) storage class where the GID and UID are not set in the storage class. +<5> The {VirtProductName} version. +<6> Specifies if there is a default storage class. +<7> The list of golden images whose data source is not ready. +<8> The list of golden images whose data import cron is not up-to-date. +<9> The {product-title} version. +<10> Specifies if a PVC of 10Mi has been created and bound by the provisioner. +<11> The list of storage profiles using snapshot-based clone but missing VolumeSnapshotClass. +<12> The list of storage profiles with unknown provisioners. +<13> The list of storage profiles with smart clone support (CSI/snapshot). +<14> The list of storage profiles spec-overriden claimPropertySets. +<15> The list of virtual machines that use the Ceph RBD storage class when the virtualization storage class exists. +<16> The list of virtual machines that use an Elastic File Store (EFS) storage class where the GID and UID are not set in the storage class. . Delete the job and config map that you previously created by running the following commands: diff --git a/modules/virt-latency-checkup-web-console.adoc b/modules/virt-latency-checkup-web-console.adoc index cd41e31f25..74b6880514 100644 --- a/modules/virt-latency-checkup-web-console.adoc +++ b/modules/virt-latency-checkup-web-console.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="virt-latency-checkup-web-console_{context}"] -= Running a latency checkup in the web console += Running a latency checkup by using the web console Run a latency checkup to verify network connectivity and measure the latency between two virtual machines attached to a secondary network interface. diff --git a/modules/virt-measuring-latency-vm-secondary-network.adoc b/modules/virt-measuring-latency-vm-secondary-network.adoc index 52b1965474..061c8c7b16 100644 --- a/modules/virt-measuring-latency-vm-secondary-network.adoc +++ b/modules/virt-measuring-latency-vm-secondary-network.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="virt-measuring-latency-vm-secondary-network_{context}"] -= Running a latency checkup on the CLI += Running a latency checkup by using the command line You use a predefined checkup to verify network connectivity and measure latency between two virtual machines (VMs) that are attached to a secondary network interface. The latency checkup uses the ping utility. diff --git a/modules/virt-storage-checkup-web-console.adoc b/modules/virt-storage-checkup-web-console.adoc index b7a0bd652f..737d89fe8b 100644 --- a/modules/virt-storage-checkup-web-console.adoc +++ b/modules/virt-storage-checkup-web-console.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="virt-storage-checkup-web-console_{context}"] -= Running a storage checkup in the web console += Running a storage checkup by using the web console Run a storage checkup to validate that storage is working correctly for virtual machines. diff --git a/virt/monitoring/virt-running-cluster-checkups.adoc b/virt/monitoring/virt-running-cluster-checkups.adoc index 77715e97fa..f30b9aa5f2 100644 --- a/virt/monitoring/virt-running-cluster-checkups.adoc +++ b/virt/monitoring/virt-running-cluster-checkups.adoc @@ -8,12 +8,15 @@ toc::[] {VirtProductName} includes the following predefined checkups that can be used for cluster maintenance and troubleshooting: -xref:../../virt/monitoring/virt-running-cluster-checkups.adoc#virt-measuring-latency-vm-secondary-network_virt-running-cluster-checkups[Latency checkup]:: -Verifies network connectivity and measures latency between two virtual machines (VMs) that are attached to a secondary network interface. -xref:../../virt/monitoring/virt-running-cluster-checkups.adoc#virt-checking-cluster-dpdk-readiness_virt-running-cluster-checkups[DPDK checkup]:: -Verifies that a node can run a VM with a Data Plane Development Kit (DPDK) workload with zero packet loss. -xref:../../virt/monitoring/virt-running-cluster-checkups.adoc#virt-checking-storage-configuration_virt-running-cluster-checkups[Storage checkup]:: -Verifies if the cluster storage is optimally configured for {VirtProductName}. +* Latency checkup, which verifies network connectivity and measures latency between two virtual machines (VMs) that are attached to a secondary network interface. ++ +[IMPORTANT] +===== +Before you run a latency checkup, you must first xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[create a bridge interface] on the cluster nodes to connect the VM's secondary interface to any interface on the node. If you do not create a bridge interface, the VMs do not start and the job fails. +===== + +* Storage checkup, which verifies if the cluster storage is optimally configured for {VirtProductName}. +* DPDK checkup, which verifies that a node can run a VM with a Data Plane Development Kit (DPDK) workload with zero packet loss. //xref:../../virt/monitoring/virt-running-cluster-checkups.adoc#virt-running-real-time-checkup_virt-running-cluster-checkups[Real-time checkup]:: //Verifies that your {product-title} cluster can run virtualized real-time workloads. @@ -22,28 +25,29 @@ include::snippets/technology-preview.adoc[] include::modules/virt-about-cluster-checkup-framework.adoc[leveloffset=+1] -== Running cluster checkups in the web console +[id="virt-running-cluster-checkups-console_{context}"] +== Running checkups by using the web console -Use the web console to run a latency or storage checkup on a cluster. - -Use the following procedures the first time you run a latency checkup and storage checkup in the web console. For additional checkups, click *Run checkup* on either checkup tab, and select the appropriate checkup from the drop down menu. - -[IMPORTANT] -==== -Before you run a latency checkup, you must first xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[create a bridge interface] on the cluster nodes to connect the VM's secondary interface to any interface on the node. If you do not create a bridge interface, the VMs will not start and the job will fail. -==== +Use the following procedures the first time you run checkups by using the web console. For additional checkups, click *Run checkup* on either checkup tab, and select the appropriate checkup from the drop down menu. include::modules/virt-latency-checkup-web-console.adoc[leveloffset=+2] include::modules/virt-storage-checkup-web-console.adoc[leveloffset=+2] -include::modules/virt-measuring-latency-vm-secondary-network.adoc[leveloffset=+1] +[id="virt-running-cluster-checkups-cli_{context}"] +== Running checkups by using the command line -include::modules/virt-checking-cluster-dpdk-readiness.adoc[leveloffset=+1] +Use the following procedures the first time you run checkups by using the command line. -include::modules/virt-dpdk-config-map-parameters.adoc[leveloffset=+2] +include::modules/virt-measuring-latency-vm-secondary-network.adoc[leveloffset=+2] -include::modules/virt-building-vm-containerdisk-image.adoc[leveloffset=+2] +include::modules/virt-checking-storage-configuration.adoc[leveloffset=+2] + +include::modules/virt-checking-cluster-dpdk-readiness.adoc[leveloffset=+2] + +include::modules/virt-dpdk-config-map-parameters.adoc[leveloffset=+3] + +include::modules/virt-building-vm-containerdisk-image.adoc[leveloffset=+3] //// include::modules/virt-running-real-time-checkup.adoc[leveloffset=+1] @@ -57,7 +61,7 @@ include::modules/virt-real-time-config-map-parameters.adoc[leveloffset=+2] include::modules/virt-building-real-time-container-disk-image.adoc[leveloffset=+2] //// -include::modules/virt-checking-storage-configuration.adoc[leveloffset=+1] + ifndef::openshift-rosa,openshift-dedicated[] [role="_additional-resources"]