From f899c39493f09a439463671cf7f04f49ae47e6f3 Mon Sep 17 00:00:00 2001 From: Gwynne Monahan Date: Tue, 3 Mar 2026 16:03:50 -0600 Subject: [PATCH] CCSINTL-3095 [POWERMON] Module short descriptions --- about/about-power-monitoring.adoc | 3 ++- ...monitoring-accessing-dashboards-admin.adoc | 3 ++- ...toring-accessing-dashboards-developer.adoc | 3 +++ .../power-monitoring-dashboards-overview.adoc | 3 ++- modules/power-monitoring-deleting-kepler.adoc | 3 ++- .../power-monitoring-hardware-support.adoc | 26 +++++++++++++++++++ modules/power-monitoring-installing-pmo.adoc | 3 ++- .../power-monitoring-kepler-architecture.adoc | 3 +++ ...power-monitoring-kepler-configuration.adoc | 6 +++++ ...r-monitoring-monitoring-kepler-status.adoc | 5 ++++ modules/power-monitoring-overview.adoc | 5 +++- .../power-monitoring-uninstalling-pmo.adoc | 3 ++- 12 files changed, 59 insertions(+), 7 deletions(-) create mode 100644 modules/power-monitoring-hardware-support.adoc diff --git a/about/about-power-monitoring.adoc b/about/about-power-monitoring.adoc index bc5132d3286b..58a24874d8e5 100644 --- a/about/about-power-monitoring.adoc +++ b/about/about-power-monitoring.adoc @@ -15,9 +15,10 @@ include::modules/power-monitoring-overview.adoc[leveloffset=+1] include::modules/power-monitoring-kepler-architecture.adoc[leveloffset=+1] -include::modules/power-monitoring-hardware-virtualization-support.adoc[leveloffset=+1] +include::modules/power-monitoring-hardware-support.adoc[leveloffset=+1] [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources * xref:../visualizing/visualizing-power-monitoring-metrics.adoc#power-monitoring-dashboards-overview_visualizing-power-monitoring-metrics[{PM-shortname-c} dashboards overview] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/installation_overview/index#installing-preparing-security[Do you need extra security for your cluster?] \ No newline at end of file diff --git a/modules/power-monitoring-accessing-dashboards-admin.adoc b/modules/power-monitoring-accessing-dashboards-admin.adoc index b1b499a99d2b..46ebd7319a82 100644 --- a/modules/power-monitoring-accessing-dashboards-admin.adoc +++ b/modules/power-monitoring-accessing-dashboards-admin.adoc @@ -6,7 +6,8 @@ [id="power-monitoring-accessing-dashboards-admin_{context}"] = Accessing {PM-shortname} dashboards as a cluster administrator -You can access {PM-shortname} dashboards of the {ocp} web console. +[role="_abstract"] +Access power monitoring dashboards from the {ocp} web console using cluster administrator credentials and permissions. .Prerequisites diff --git a/modules/power-monitoring-accessing-dashboards-developer.adoc b/modules/power-monitoring-accessing-dashboards-developer.adoc index cd2f79171bf6..2e634114ae4e 100644 --- a/modules/power-monitoring-accessing-dashboards-developer.adoc +++ b/modules/power-monitoring-accessing-dashboards-developer.adoc @@ -6,6 +6,9 @@ [id="power-monitoring-accessing-dashboards-developer_{context}"] = Accessing {PM-shortname} dashboards as a developer +[role="_abstract"] +Access {PM-shortname} dashboards from the {ocp} web console using developer credentials and view permissions for monitoring. + You can access {PM-shortname} dashboards from {ocp} web console. .Prerequisites diff --git a/modules/power-monitoring-dashboards-overview.adoc b/modules/power-monitoring-dashboards-overview.adoc index d3a9ccbda566..57e9fbdd6f45 100644 --- a/modules/power-monitoring-dashboards-overview.adoc +++ b/modules/power-monitoring-dashboards-overview.adoc @@ -6,7 +6,8 @@ [id="power-monitoring-dashboards-overview_{context}"] = {PM-shortname-c} dashboards overview -There are two types of {PM-shortname} dashboards. Both provide different levels of details around power consumption metrics for a single cluster: +[role="_abstract"] +{PM-shortname} provides two dashboards for visualizing cluster power consumption at node, namespace, and pod levels. [id="power-monitoring-overview-dashboard_{context}"] == Power Monitoring / Overview dashboard diff --git a/modules/power-monitoring-deleting-kepler.adoc b/modules/power-monitoring-deleting-kepler.adoc index 14cd7ccb35dd..7134610c9674 100644 --- a/modules/power-monitoring-deleting-kepler.adoc +++ b/modules/power-monitoring-deleting-kepler.adoc @@ -6,7 +6,8 @@ [id="power-monitoring-deleting-kepler_{context}"] = Deleting {PM-kepler} -You can delete {PM-kepler} by removing the {PM-kepler} instance of the `{PM-kepler}` custom resource definition (CRD) from the {ocp} web console. +[role="_abstract"] +Remove {PM-kepler} by deleting the {PM-kepler} custom resource instance from the {ocp} web console. .Prerequisites * You have access to the {ocp} web console. diff --git a/modules/power-monitoring-hardware-support.adoc b/modules/power-monitoring-hardware-support.adoc new file mode 100644 index 000000000000..b843b4d73ce3 --- /dev/null +++ b/modules/power-monitoring-hardware-support.adoc @@ -0,0 +1,26 @@ +// Module included in the following assemblies: +// +// * power_monitoring/power-monitoring-overview.adoc + +:_mod-docs-content-type: CONCEPT +[id="power-monitoring-hardware-virtualization-support_{context}"] += {PM-kepler} hardware and virtualization support + +[role="_abstract"] +{PM-kepler} collects power consumption data using kernel power management subsystems or machine learning estimators when hardware access is unavailable. + +{PM-kepler} is the key component of {PM-shortname} that collects real-time power consumption data from a node through one of the following methods: + +Kernel Power Management Subsystem (preferred):: +* `rapl-sysfs`: This requires access to the `/sys/class/powercap/intel-rapl` host file. +* `rapl-msr`: This requires access to the `/dev/cpu/*/msr` host file. + +The `estimator` power source:: +Without access to the kernel's power cap subsystem, {PM-kepler} uses a machine learning model to estimate the power usage of the CPU on the node. ++ +[WARNING] +==== +The `estimator` feature is experimental, not supported, and should not be relied upon. +==== + +You can identify the power estimation method for a node by using the *Power Monitoring / Overview* dashboard. \ No newline at end of file diff --git a/modules/power-monitoring-installing-pmo.adoc b/modules/power-monitoring-installing-pmo.adoc index 672b8b4a4942..009a50849579 100644 --- a/modules/power-monitoring-installing-pmo.adoc +++ b/modules/power-monitoring-installing-pmo.adoc @@ -6,7 +6,8 @@ [id="power-monitoring-installing-pmo_{context}"] = Installing the {PM-operator} -As a cluster administrator, you can install the {PM-operator} from the software catalog by using the {ocp} web console. +[role="_abstract"] +Install the {PM-operator} from the software catalog using the {ocp} web console. [WARNING] ==== diff --git a/modules/power-monitoring-kepler-architecture.adoc b/modules/power-monitoring-kepler-architecture.adoc index 101a8b669661..c7c3bb86492a 100644 --- a/modules/power-monitoring-kepler-architecture.adoc +++ b/modules/power-monitoring-kepler-architecture.adoc @@ -6,6 +6,9 @@ [id="power-monitoring-kepler-architecture_{context}"] = {PM-shortname-c} architecture +[role="_abstract"] +{PM-shortname-c} consists of the {PM-operator} for management and {PM-kepler} for collecting power metrics. + {PM-shortname-c} is made up of the following major components: 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 {ocp} 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}. diff --git a/modules/power-monitoring-kepler-configuration.adoc b/modules/power-monitoring-kepler-configuration.adoc index 1a5af2e67c7b..27101c4600d2 100644 --- a/modules/power-monitoring-kepler-configuration.adoc +++ b/modules/power-monitoring-kepler-configuration.adoc @@ -6,7 +6,13 @@ [id="power-monitoring-kepler-configuration_{context}"] = The {PM-kepler} configuration +<<<<<<< HEAD You can configure {PM-kepler} with the `spec` field of the `{PM-kepler}` resource. +======= +[role="_abstract"] +Configuration options available for customizing Kepler deployment, security, logging, and metric collection through `PowerMonitor` resources. + +>>>>>>> 7976eadb9e (CCSINTL-3095 [POWERMON] Module short descriptions) [IMPORTANT] ==== diff --git a/modules/power-monitoring-monitoring-kepler-status.adoc b/modules/power-monitoring-monitoring-kepler-status.adoc index ad9b949ad61b..e62ab9b9fb04 100644 --- a/modules/power-monitoring-monitoring-kepler-status.adoc +++ b/modules/power-monitoring-monitoring-kepler-status.adoc @@ -6,7 +6,12 @@ [id="power-monitoring-monitoring-kepler-status_{context}"] = Monitoring the {PM-kepler} status +<<<<<<< HEAD You can monitor the state of the {PM-kepler} exporter with the `status` field of the `{PM-kepler}` resource. +======= +[role="_abstract"] +The `PowerMonitor` resource status field provides real-time information about Kepler pod deployment state and health across nodes. +>>>>>>> 7976eadb9e (CCSINTL-3095 [POWERMON] Module short descriptions) The `status.exporter` field includes information, such as the following: diff --git a/modules/power-monitoring-overview.adoc b/modules/power-monitoring-overview.adoc index 9af01139ad46..11432b5eea9b 100644 --- a/modules/power-monitoring-overview.adoc +++ b/modules/power-monitoring-overview.adoc @@ -6,7 +6,10 @@ [id="power-monitoring-overview_{context}"] = {PM-shortname-c} overview -You can use {PM-title} to monitor the power usage and identify power-consuming containers running in an {ocp} 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. +[role="_abstract"] +{PM-title} tracks energy consumption across {ocp}cluster infrastructure and provides granular metrics for pods and namespaces. + +You can use {PM-title} to monitor the power usage and identify power-consuming containers running in an {ocp} 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. [WARNING] ==== diff --git a/modules/power-monitoring-uninstalling-pmo.adoc b/modules/power-monitoring-uninstalling-pmo.adoc index 7325641d7605..6a0076ef6503 100644 --- a/modules/power-monitoring-uninstalling-pmo.adoc +++ b/modules/power-monitoring-uninstalling-pmo.adoc @@ -6,7 +6,8 @@ [id="power-monitoring-uninstalling-pmo_{context}"] = Uninstalling the {PM-operator} -If you installed the {PM-operator} by using the software catalog, you can uninstall it from the {ocp} web console. +[role="_abstract"] +Uninstall the {PM-operator} from the {ocp} web console after deleting Kepler. .Prerequisites * You have access to the {ocp} web console.