From 9b2cc478e1fa7857bfeea41eb48f9df7f9c833c8 Mon Sep 17 00:00:00 2001 From: Gwynne Monahan Date: Tue, 3 Mar 2026 16:03:50 -0600 Subject: [PATCH 1/2] CCSINTL-3095 [POWERMON] Module short descriptions --- modules/power-monitoring-dashboards-overview.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/power-monitoring-dashboards-overview.adoc b/modules/power-monitoring-dashboards-overview.adoc index 668206f0ed4e..19598564b0ce 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 Monitor / Overview dashboard From addb439025e71e08911820eb23200b403ea74146 Mon Sep 17 00:00:00 2001 From: Gwynne Monahan Date: Tue, 3 Mar 2026 16:15:37 -0600 Subject: [PATCH 2/2] Add short descriptions to remaining modules (Squash) --- modules/power-monitoring-accessing-dashboards-admin.adoc | 3 ++- modules/power-monitoring-accessing-dashboards-developer.adoc | 3 +++ modules/power-monitoring-deleting-kepler.adoc | 3 ++- ...er-monitoring-deleting-power-monitor-custom-resource.adoc | 3 ++- ...r-monitoring-deploying-power-monitor-custom-resource.adoc | 4 +++- modules/power-monitoring-fips-support.adoc | 5 ++++- modules/power-monitoring-hardware-support.adoc | 3 +++ modules/power-monitoring-installing-pmo.adoc | 3 ++- modules/power-monitoring-kepler-architecture.adoc | 3 +++ modules/power-monitoring-kepler-configuration.adoc | 4 +++- modules/power-monitoring-kepler-power-attribution-guide.adoc | 5 ++++- modules/power-monitoring-monitoring-kepler-status.adoc | 3 ++- modules/power-monitoring-overview.adoc | 3 +++ ...ing-release-notes-tp-0-5-deprecated-removed-features.adoc | 3 +++ .../power-monitoring-release-notes-tp-0-5-enhancements.adoc | 3 +++ .../power-monitoring-release-notes-tp-0-5-new-features.adoc | 3 +++ ...power-monitoring-release-notes-tp-0-5-support-tables.adoc | 4 ++++ modules/power-monitoring-uninstalling-pmo.adoc | 3 ++- 18 files changed, 51 insertions(+), 10 deletions(-) diff --git a/modules/power-monitoring-accessing-dashboards-admin.adoc b/modules/power-monitoring-accessing-dashboards-admin.adoc index 09e1d1759526..7754ae0bf15a 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 b6fa4a35b965..98545a74f2e0 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-deleting-kepler.adoc b/modules/power-monitoring-deleting-kepler.adoc index 35bc20e57648..ccb172276afd 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. [IMPORTANT] ==== diff --git a/modules/power-monitoring-deleting-power-monitor-custom-resource.adoc b/modules/power-monitoring-deleting-power-monitor-custom-resource.adoc index c02e42868b79..2c0200282110 100644 --- a/modules/power-monitoring-deleting-power-monitor-custom-resource.adoc +++ b/modules/power-monitoring-deleting-power-monitor-custom-resource.adoc @@ -6,7 +6,8 @@ [id="power-monitoring-deleting-power-monitoring-custom-resource_{context}"] = Deleting the PowerMonitor custom resource -You can delete the `PowerMonitor` custom resource (CR) by removing the `power-monitor` instance of the `PowerMonitor` CR from the {ocp} web console. +[role="_abstract"] +Remove the `PowerMonitor` custom resource by deleting the `power-monitor` instance from the {ocp} web console. .Prerequisites diff --git a/modules/power-monitoring-deploying-power-monitor-custom-resource.adoc b/modules/power-monitoring-deploying-power-monitor-custom-resource.adoc index c899fc6efd09..9e997fddc904 100644 --- a/modules/power-monitoring-deploying-power-monitor-custom-resource.adoc +++ b/modules/power-monitoring-deploying-power-monitor-custom-resource.adoc @@ -6,7 +6,9 @@ [id="power-monitoring-deploying-power-monitor-custom-resource_{context}"] = Deploying PowerMonitor custom resource -You can deploy {PM-kepler} by creating an instance of the `PowerMonitor` custom resource (CR) using the {PM-operator}. +[role="_abstract"] +Deploy {PM-kepler} by creating a `PowerMonitor` custom resource instance using the {PM-operator}. + [IMPORTANT] ==== diff --git a/modules/power-monitoring-fips-support.adoc b/modules/power-monitoring-fips-support.adoc index a658968009f9..f589547b1444 100644 --- a/modules/power-monitoring-fips-support.adoc +++ b/modules/power-monitoring-fips-support.adoc @@ -6,7 +6,10 @@ [id="power-monitoring-fips-support_{context}"] = About FIPS compliance for {PM-operator} -Starting with version 0.4, {PM-operator} for Red{nbsp}Hat OpenShift is FIPS compliant. When deployed on an {ocp} cluster in FIPS mode, it uses {op-system-base-full} cryptographic libraries validated by National Institute of Standards and Technology (NIST). +[role="_abstract"] +The {PM-operator} version 0.4 and later is FIPS compliant when deployed on {ocp} clusters in FIPS mode. + +When deployed on an {ocp} cluster in FIPS mode, it uses {op-system-base-full} cryptographic libraries validated by National Institute of Standards and Technology (NIST). For details on the NIST validation program, see link:https://csrc.nist.gov/Projects/cryptographic-module-validation-program/validated-modules[Cryptographic module validation program]. For the latest NIST status of {op-system-base} cryptographic libraries, see link:https://access.redhat.com/en/compliance[Compliance activities and government standards]. diff --git a/modules/power-monitoring-hardware-support.adoc b/modules/power-monitoring-hardware-support.adoc index 1b885cf1c664..3b52eb0220d8 100644 --- a/modules/power-monitoring-hardware-support.adoc +++ b/modules/power-monitoring-hardware-support.adoc @@ -6,6 +6,9 @@ [id="power-monitoring-hardware-support_{context}"] = {PM-kepler} hardware support +[role="_abstract"] +{PM-kepler} collects CPU power consumption data from nodes using the RAPL subsystem through the rapl-sysfs interface. + {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. Kernel Power Management Subsystem:: 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 b3f2ec6106a6..8dd2b30dabbc 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 `PowerMonitor` 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 de8d30551b6c..60452e3e6ed4 100644 --- a/modules/power-monitoring-kepler-configuration.adoc +++ b/modules/power-monitoring-kepler-configuration.adoc @@ -6,7 +6,9 @@ [id="power-monitoring-kepler-configuration_{context}"] = The {PM-kepler} configuration -You can configure {PM-kepler} with the `spec` field of the `PowerMonitor` resource. +[role="_abstract"] +Configuration options available for customizing Kepler deployment, security, logging, and metric collection through `PowerMonitor` resources. + [IMPORTANT] ==== diff --git a/modules/power-monitoring-kepler-power-attribution-guide.adoc b/modules/power-monitoring-kepler-power-attribution-guide.adoc index f39116c38ed6..0a77afd81a0c 100644 --- a/modules/power-monitoring-kepler-power-attribution-guide.adoc +++ b/modules/power-monitoring-kepler-power-attribution-guide.adoc @@ -2,6 +2,9 @@ [id="power-monitoring-kepler-power-attribution-guide_{context}"] == Power monitoring Kepler power attribution guide -Kepler's power attribution system provides practical, proportional distribution of hardware energy consumption to individual workloads. While CPU-time-based attribution has inherent limitations due to modern CPU complexity, it offers a good balance between accuracy, simplicity, and performance overhead for most monitoring and optimization use cases. +[role="_abstract"] +Kepler attributes hardware energy consumption proportionally to individual workloads using CPU-time-based distribution for practical power monitoring. + +While CPU-time-based attribution has inherent limitations due to modern CPU complexity, it offers a good balance between accuracy, simplicity, and performance overhead for most monitoring and optimization use cases. For more information about power attribution, see link:http://sustainable-computing.io/kepler/usage/power-attribution[Kepler Power Attribution Guide]. \ No newline at end of file diff --git a/modules/power-monitoring-monitoring-kepler-status.adoc b/modules/power-monitoring-monitoring-kepler-status.adoc index 36a1c5c68f49..ebbc8fb09fcc 100644 --- a/modules/power-monitoring-monitoring-kepler-status.adoc +++ b/modules/power-monitoring-monitoring-kepler-status.adoc @@ -6,7 +6,8 @@ [id="power-monitoring-monitoring-kepler-status_{context}"] = Monitoring the {PM-kepler} status -You can monitor the state of the {PM-kepler} exporter with the `status` field of the `PowerMonitor` resource. +[role="_abstract"] +The `PowerMonitor` resource status field provides real-time information about Kepler pod deployment state and health across nodes. The `status` field includes information, such as the following: diff --git a/modules/power-monitoring-overview.adoc b/modules/power-monitoring-overview.adoc index 33179c12b98f..11432b5eea9b 100644 --- a/modules/power-monitoring-overview.adoc +++ b/modules/power-monitoring-overview.adoc @@ -6,6 +6,9 @@ [id="power-monitoring-overview_{context}"] = {PM-shortname-c} overview +[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-release-notes-tp-0-5-deprecated-removed-features.adoc b/modules/power-monitoring-release-notes-tp-0-5-deprecated-removed-features.adoc index 6a99f96eb831..8413faca36ef 100644 --- a/modules/power-monitoring-release-notes-tp-0-5-deprecated-removed-features.adoc +++ b/modules/power-monitoring-release-notes-tp-0-5-deprecated-removed-features.adoc @@ -6,6 +6,9 @@ [id="power-monitoring-0-5-deprecated-removed-features_{context}"] = Power monitoring 0.5 (Technology Preview) deprecated and removed features +[role="_abstract"] +Review deprecated and removed features that might affect your use of the {PM-shortname} 0.5 Technology Preview release. + * In the Red Hat OpenShift power monitoring technology preview 0.5 release, the `Kepler` custom resource has been deprecated, and will be removed in a future release. Use the `PowerMonitor` custom resource instead. * In the Red Hat OpenShift power monitoring technology preview 0.5 release, the Redfish configuration has been removed. It is no longer supported in previous versions of power monitoring. \ No newline at end of file diff --git a/modules/power-monitoring-release-notes-tp-0-5-enhancements.adoc b/modules/power-monitoring-release-notes-tp-0-5-enhancements.adoc index 5f390f5fce3a..f23e2b50ce04 100644 --- a/modules/power-monitoring-release-notes-tp-0-5-enhancements.adoc +++ b/modules/power-monitoring-release-notes-tp-0-5-enhancements.adoc @@ -6,6 +6,9 @@ [id="power-monitoring-tp-0-5-enhancements_{context}"] = Power monitoring Technology Preview 0.5 enhancements +[role="_abstract"] +Power monitoring 0.5 Technology Preview includes improved accuracy, reduced resource usage, multi-level energy tracking, and updated visualization dashboards. + This release of {PM-title} and the {PM-operator}, based on the Kepler Project, includes the following enhancements: * Dynamic detection of Nodes Running Average Power Limit (RAPL) zones diff --git a/modules/power-monitoring-release-notes-tp-0-5-new-features.adoc b/modules/power-monitoring-release-notes-tp-0-5-new-features.adoc index 50e2b4697dde..40e97482ddc7 100644 --- a/modules/power-monitoring-release-notes-tp-0-5-new-features.adoc +++ b/modules/power-monitoring-release-notes-tp-0-5-new-features.adoc @@ -6,6 +6,9 @@ [id="power-monitoring-release-notes-tp-0-5-new-features_{context}"] = Power monitoring Technology Preview 0.5 new features +[role="_abstract"] +Power monitoring 0.5 Technology Preview introduces support for deploying and deleting `PowerMonitor` custom resources. + This release of {PM-title} and the {PM-operator}, based on the Kepler Project, includes the following new feature: * Deployment and deletion of `PowerMonitor` custom resource definition (CRD). \ No newline at end of file diff --git a/modules/power-monitoring-release-notes-tp-0-5-support-tables.adoc b/modules/power-monitoring-release-notes-tp-0-5-support-tables.adoc index 10eb22e6744e..c7aaf1177495 100644 --- a/modules/power-monitoring-release-notes-tp-0-5-support-tables.adoc +++ b/modules/power-monitoring-release-notes-tp-0-5-support-tables.adoc @@ -5,6 +5,10 @@ :_mod-docs-content-type: REFERENCE [id="power-monitoring-release-notes-tp-0-5-support-tables_{context}"] = {PM-shortname-c} 0.5 (Technology Preview) support tables + +[role="_abstract"] +Supported versions and platform requirements for power monitoring 0.5 Technology Preview, including {PM-kepler} and {PM-operator} version compatibility. + //may need to update the title This release includes the following support updates: 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.