diff --git a/modules/virt-numa-check-config.adoc b/modules/virt-numa-check-config.adoc new file mode 100644 index 000000000000..2b28eda01d6f --- /dev/null +++ b/modules/virt-numa-check-config.adoc @@ -0,0 +1,30 @@ +// Module included in the following assemblies: +// +// * virt/managing_vms/advanced_vm_management/virt-NUMA-topology.adoc + +:_mod-docs-content-type: PROCEDURE +[id="virt-numa-check-config_{context}"] += Verifying vNUMA status of a VM + +[role="_abstract"] +VM administrators might need to confirm whether non-uniform memory access (NUMA) is configured for a VM, to verify the VM's resource allocation setup for high-performance, latency-sensitive workloads that rely on memory locality. + +You can verify whether an already deployed VM is configured for vNUMA by checking the `spec.domain.cpu.numa` attribute. This is displayed as a *vNUMA* badge in the {product-title} web console. + +.Prerequisites + +* You have access to an {product-title} cluster with {VirtProductName} installed. +* If you want to use the command line for verification, you must have installed the {oc-first}. Otherwise, you only need access to the {product-title} web console. + +.Procedure + +* To verify vNUMA status on the command line, check that the `spec.domain.cpu.numa` attribute is configured by using the {oc-first}. Run the following command: ++ +[source,terminal] +---- +$ oc get vm -n -o jsonpath='{.spec.template.spec.domain.cpu.numa}' +---- ++ +If any output other than an empty string is returned, vNUMA is enabled for the VM. + +* To verify vNUMA status in a GUI, check if the VM has a *vNUMA* badge in the {product-title} web console. Go to *VirtualMachines* -> *VirtualMachine details*, and check either the *Overview* or the *Configuration* tabs. diff --git a/virt/managing_vms/advanced_vm_management/virt-NUMA-topology.adoc b/virt/managing_vms/advanced_vm_management/virt-NUMA-topology.adoc index b37c5a37cb04..56e43c36ee68 100644 --- a/virt/managing_vms/advanced_vm_management/virt-NUMA-topology.adoc +++ b/virt/managing_vms/advanced_vm_management/virt-NUMA-topology.adoc @@ -19,6 +19,8 @@ VM owners can enable NUMA with `ComputeExclusive` (CX) instance types, which are For information about creating VMs using a CX instance type, see xref:../../../virt/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[Creating virtual machines from instance types]. +include::modules/virt-numa-check-config.adoc[leveloffset=+1] + [id="virt-NUMA-topology-disabling-hotplugs"] == Disabling the hot plug capability for VMs