Skip to content

Commit 1e34213

Browse files
sjhala-ccssjhala-ccs
authored
Merge pull request #39721 from lmandavi/CNV-14966-Virt-Overview
CNV-14966: Virtualization Overview
2 parents ac0f068 + a27f9d0 commit 1e34213

8 files changed

+188
-2
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3104,6 +3104,8 @@ Topics:
31043104
- Name: Logging, events, and monitoring
31053105
Dir: logging_events_monitoring
31063106
Topics:
3107+
- Name: Reviewing virtualization overview
3108+
File: virt-reviewing-virtualization-overview
31073109
- Name: Viewing logs
31083110
File: virt-logs
31093111
- Name: Viewing events

‎modules/virt-about-reviewing-top-consumers.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
// Module included in the following assembly:
1+
// Module included in the following assemblies:
22
//
33
// * virt/logging_events_monitoring/virt-reviewing-vm-dashboard.adoc
4-
//
54

65
[id="virt-about-reviewing-top-consumers_{context}"]
76
= About reviewing top consumers

‎modules/virt-about-top-consumers-projects-vms-nodes.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Module included in the following assembly:
2+
//
3+
// * virt/logging_events_monitoring/virt-reviewing-virtualization-overview.adoc
4+
5+
[id="virt-about-reviewing-top-consumers-projects-vms-nodes_{context}"]
6+
= About top consumers for projects, virtual machines, and nodes
7+
8+
The *Top Consumers* cards display projects, virtual machines or nodes with maximum consumption of a resource. You can select a project, a virtual machine, or a node and view the top five or top ten consumers of a specific resource.
9+
10+
[NOTE]
11+
====
12+
Viewing the maximum resource consumption is limited to the top five or top ten consumers within each *Top Consumers* card.
13+
====
14+
15+
The following table shows resources monitored for top consumers.
16+
17+
[cols="1,1"]
18+
|===
19+
|*Resources monitored for top consumption* | *Description*
20+
|CPU
21+
|Projects, virtual machines, or nodes consuming the most CPU.
22+
|Memory
23+
|Projects, virtual machines, or nodes consuming the most memory (in bytes). The unit of display (for example, MiB or GiB) is determined by the size of the resource consumption.
24+
|Used filesystem
25+
|Projects, virtual machines, or nodes with the highest consumption of filesystems (in bytes). The unit of display (for example, MiB or GiB) is determined by the size of the resource consumption.
26+
|Memory swap
27+
|Projects, virtual machines, or nodes consuming the most memory pressure when memory is swapped .
28+
|vCPU wait
29+
|Projects, virtual machines, or nodes experiencing the maximum wait time (in seconds) for the vCPUs.
30+
|Storage throughput
31+
|Projects, virtual machines, or nodes with the highest data transfer rate to and from the storage media (in mbps).
32+
|Storage IOPS
33+
|Projects, virtual machines, or nodes with the highest amount of storage IOPS (input/output operations per second) over a time period.
34+
|===

‎modules/virt-about-virtualization-overview.adoc

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// Module included in the following assembly:
2+
//
3+
// * virt/logging_events_monitoring/virt-reviewing-vm-dashboard.adoc
4+
//
5+
6+
[id="virt-about-reviewing-top-consumers_{context}"]
7+
= About reviewing top consumers
8+
9+
In the {VirtProductName} dashboard, you can select a specific time period and view the top consumers of resources within that time period. Top consumers are virtual machines or `virt-launcher` pods that are consuming the highest amount of resources.
10+
11+
The following table shows resources monitored in the dashboard and describes the metrics associated with each resource for top consumers.
12+
13+
[cols="1,1"]
14+
|===
15+
|*Monitored resources* | *Description*
16+
|Memory swap traffic
17+
|Virtual machines consuming the most memory pressure when swapping memory.
18+
|vCPU wait
19+
|Virtual machines experiencing the maximum wait time (in seconds) for their vCPUs.
20+
|CPU usage by pod
21+
|The `virt-launcher` pods that are using the most CPU.
22+
|Network traffic
23+
|Virtual machines that are saturating the network by receiving the most amount of network traffic (in bytes).
24+
|Storage traffic
25+
|Virtual machines with the highest amount (in bytes) of storage-related traffic.
26+
|Storage IOPS
27+
|Virtual machines with the highest amount of I/O operations per second over a time period.
28+
|Memory usage
29+
|The `virt-launcher` pods that are using the most memory (in bytes).
30+
|===
31+
32+
[NOTE]
33+
====
34+
Viewing the maximum resource consumption is limited to the top five consumers.
35+
====

‎modules/virt-resources-monitored-actively-in-Virtualization-Overview-page.adoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
// Module included in the following assembly:
2+
//
3+
// * virt/logging_events_monitoring/virt-resources-monitored-actively-in-Virtualization-Overview-page.adoc
4+
//
5+
6+
[id="virt-resources-monitored-actively-in-Virtualization-Overview-page_{context}"]
7+
= Resources monitored actively in the Virtualization Overview page
8+
9+
The following table shows actively monitored resources, metrics, and fields in the *Virtualization Overview* page. This information is useful when you need to obtain relevant data and intervene to resolve a problem.
10+
11+
[cols="1,1"]
12+
|===
13+
|*Monitored resources, fields, and metrics* | *Description*
14+
|Details
15+
|A brief overview of service and version information for *{VirtProductName}*.
16+
|Status
17+
|Alerts for virtualization and networking.
18+
|Activity
19+
|Ongoing events for virtual machines. Messages are related to recent activity in the cluster, such as pod creation or virtual machine migration to another host.
20+
|Running VMs by Template
21+
|The donut chart displays a unique color for each virtual machine template and shows the number of running virtual machines that use each template.
22+
|Inventory
23+
|Total number of active virtual machines, templates, nodes, and networks.
24+
|Status of VMs
25+
|Current status of virtual machines: *running*, *provisioning*, *starting*, *migrating*, *paused*, *stopping*, *terminating*, and *unknown*.
26+
|Permissions
27+
|Tasks for which capabilities are enabled through permissions: *Access to public templates*, *Access to public boot sources*, *Clone a VM*, *Attach VM to multiple networks*, *Upload a base image from local disk*, and *Share templates*.
28+
|===

‎modules/virt-resources-monitored-for-top-consumption.adoc

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Module included in the following assembly:
2+
//
3+
// * virt/logging_events_monitoring/virt-reviewing-virtualization-overview.adoc
4+
5+
[id="virt-resources-monitored-for_top_consumption_{context}"]
6+
= Resources monitored for top consumption
7+
8+
The *Top Consumers* cards in *Virtualization Overview* page display projects, virtual machines or nodes with maximum consumption of a resource. You can select a project, a virtual machine, or a node and view the top five or top ten consumers of a specific resource.
9+
10+
[NOTE]
11+
====
12+
Viewing the maximum resource consumption is limited to the top five or top ten consumers within each *Top Consumers* card.
13+
====
14+
15+
The following table shows resources monitored for top consumers.
16+
17+
[cols="1,1"]
18+
|===
19+
|*Resources monitored for top consumption* | *Description*
20+
|CPU
21+
|Projects, virtual machines, or nodes consuming the most CPU.
22+
|Memory
23+
|Projects, virtual machines, or nodes consuming the most memory (in bytes). The unit of display (for example, MiB or GiB) is determined by the size of the resource consumption.
24+
|Used filesystem
25+
|Projects, virtual machines, or nodes with the highest consumption of filesystems (in bytes). The unit of display (for example, MiB or GiB) is determined by the size of the resource consumption.
26+
|Memory swap
27+
|Projects, virtual machines, or nodes consuming the most memory pressure when memory is swapped .
28+
|vCPU wait
29+
|Projects, virtual machines, or nodes experiencing the maximum wait time (in seconds) for the vCPUs.
30+
|Storage throughput
31+
|Projects, virtual machines, or nodes with the highest data transfer rate to and from the storage media (in mbps).
32+
|Storage IOPS
33+
|Projects, virtual machines, or nodes with the highest amount of storage IOPS (input/output operations per second) over a time period.
34+
|===

‎modules/virt-reviewing-top-consumers-projects-vms-nodes.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/logging_events_monitoring/virt-reviewing-virtualization-overview.adoc
4+
5+
[id="virt-reviewing-top-consumers-projects-vms-nodes_{context}"]
6+
= Reviewing top consumers for projects, virtual machines, and nodes
7+
8+
You can view the top consumers of resources for a selected project, virtual machine, or node in the *Virtualization Overview* page.
9+
10+
.Prerequisites
11+
12+
* You have access to the cluster as a user with the `cluster-admin` role.
13+
14+
.Procedure
15+
16+
. In the *Administrator* perspective in the {VirtProductName} web console, navigate to *Virtualization* -> *Overview*.
17+
18+
. Navigate to the *Top Consumers* cards.
19+
20+
. From the drop-down menu, select *Show top 5* or *Show top 10*.
21+
22+
. For a *Top Consumer* card, select the type of resource from the drop-down menu: *CPU*, *Memory*, *Used Filesystem*, *Memory Swap*, *vCPU Wait*, or *Storage Throughput*.
23+
24+
. Select *By Project*, *By VM*, or *By Node*. A list of the top five or top ten consumers of the selected resource is displayed.

‎virt/logging_events_monitoring/virt-reviewing-virtualization-overview.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[id="virt-reviewing-virtualization-overview"]
2+
= Reviewing Virtualization Overview
3+
include::modules/virt-document-attributes.adoc[]
4+
:context: virt-reviewing-virtualization-overview
5+
6+
toc::[]
7+
8+
The *Virtualization Overview* page provides a comprehensive view of virtualization resources, details, status, and top consumers. By gaining an insight into the overall health of {VirtProductName}, you can determine if intervention is required to resolve specific issues identified by examining the data.
9+
10+
Use the *Getting Started* resources to access quick starts, read the latest blogs on virtualization, and learn how to use operators. Obtain complete information about alerts, events, inventory, and status of virtual machines. Customize the *Top Consumer* cards to obtain data on high utilization of a specific resource by projects, virtual machines, or nodes. Click *View virtualization dashboard* for quick access to the xref:../../virt/logging_events_monitoring/virt-reviewing-vm-dashboard.adoc#virt-reviewing-vm-dashboard[Dashboards] page.
11+
12+
[id="prerequisites_{context}"]
13+
== Prerequisites
14+
15+
To use the *vCPU wait* metric in the *Top Consumers* card, the `schedstats=enable` kernel argument must be applied to the `MachineConfig` object. This kernel argument enables scheduler statistics used for debugging and performance tuning and adds a minor additional load to the scheduler. See the xref:../../post_installation_configuration/machine-configuration-tasks.adoc#nodes-nodes-kernel-arguments_post-install-machine-configuration-tasks[{product-title} machine configuration tasks] documentation for more information on applying a kernel argument.
16+
17+
include::modules/virt-resources-monitored-actively-in-Virtualization-Overview-page.adoc[leveloffset=+1]
18+
19+
include::modules/virt-resources-monitored-for-top-consumption.adoc[leveloffset=+1]
20+
21+
include::modules/virt-reviewing-top-consumers-projects-vms-nodes.adoc[leveloffset=+1]
22+
23+
[id="additional-resources_reviewing-virtualization-overview"]
24+
== Additional resources
25+
26+
* xref:../../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Understanding the {product-title} monitoring stack]
27+
28+
* xref:../../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
29+
30+
* xref:../../virt/logging_events_monitoring/virt-reviewing-vm-dashboard.adoc#virt-reviewing-vm-dashboard[Dashboards]

0 commit comments

Comments
 (0)