Skip to content

Commit 1484b6e

Browse files
gwynnemonahaneromanova97
authored andcommitted
[POWERMON] POWERMON-581 0.5 Overview doc updates
1 parent 39355bd commit 1484b6e

5 files changed

+15
-26
lines changed

modules/power-monitoring-about-power-monitoring.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="power-monitoring-about-power-monitoring_{context}"]
77
= About {PM-shortname}
88

9-
You can use {PM-title} to monitor the power usage and identify power-consuming containers running in an {product-title} cluster. {PM-shortname-c} collects and exports energy-related system statistics from various components, such as CPU and DRAM. It provides granular power consumption data for Kubernetes pods, namespaces, and nodes.
9+
You can use {PM-title} to monitor the power usage and identify power-consuming containers running in an {product-title} cluster. {PM-shortname-c} collects and exports energy-related system statistics from various components, such as CPU and DRAM. It provides estimates and granular power consumption data for Kubernetes pods and namespaces, and reads the power consumption of nodes.
1010

1111
[WARNING]
1212
====
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * power_monitoring/power-monitoring-overview.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="power-monitoring-hardware-support_{context}"]
7+
= {PM-kepler} hardware support
8+
9+
{PM-kepler} is the key component of {PM-shortname} that collects real-time CPU power consumption data from a node through the RAPL Subsystem. By understanding the total power consumption of the node and calculating the percent of CPU time each process is using, it is able to estimate the power consumption at a per process and container level.
10+
11+
Kernel Power Management Subsystem::
12+
* `rapl-sysfs`: This requires access to the `/sys/class/powercap/intel-rapl` directory.

modules/power-monitoring-hardware-virtualization-support.adoc

Lines changed: 0 additions & 23 deletions
This file was deleted.

modules/power-monitoring-kepler-architecture.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@
88

99
{PM-shortname-c} is made up of the following major components:
1010

11-
The {PM-operator}:: For administrators, the {PM-operator} streamlines the monitoring of power usage for workloads by simplifying the deployment and management of {PM-kepler} in an {product-title} cluster. The setup and configuration for the {PM-operator} are simplified by adding a {PM-kepler} custom resource definition (CRD). The Operator also manages operations, such as upgrading, removing, configuring, and redeploying {PM-kepler}.
11+
The {PM-operator}:: For administrators, the {PM-operator} streamlines the monitoring of power usage for workloads by simplifying the deployment and management of {PM-kepler} in an {product-title} cluster. The setup and configuration for the {PM-operator} are simplified by adding a `PowerMonitor` custom resource definition (CRD). The Operator also manages operations, such as upgrading, removing, configuring, and redeploying {PM-kepler}.
1212

1313
{PM-kepler}:: {PM-kepler} is a key component of {PM-shortname}. It is responsible for monitoring the power usage of containers running in {product-title}. It generates metrics related to the power usage of both nodes and containers.

observability/power_monitoring/power-monitoring-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ include::modules/power-monitoring-about-power-monitoring.adoc[leveloffset=+1]
1313

1414
include::modules/power-monitoring-kepler-architecture.adoc[leveloffset=+1]
1515

16-
include::modules/power-monitoring-hardware-virtualization-support.adoc[leveloffset=+1]
16+
include::modules/power-monitoring-hardware-support.adoc[leveloffset=+1]
1717

1818
include::modules/power-monitoring-fips-support.adoc[leveloffset=+1]
1919

0 commit comments

Comments
 (0)