Merge pull request #96947 from eromanova97/power-monitoring-0.5-integration

Power monitoring 0.5 integration

Author: eromanova97

_topic_maps/_topic_map.yml

@@ -3290,6 +3290,8 @@ Topics:
   Dir: power_monitoring
   Distros: openshift-enterprise,openshift-origin
   Topics:
+  - Name: Power monitoring 0.5 release notes
+    File: power-monitoring-release-notes-tp-0-5
   - Name: Power monitoring release notes
     File: power-monitoring-release-notes
   - Name: Power monitoring overview
@@ -3302,6 +3304,10 @@ Topics:
     File: visualizing-power-monitoring-metrics
   - Name: Uninstalling power monitoring
     File: uninstalling-power-monitoring
+  - Name: Power monitoring references
+    File: power-monitoring-references
+  - Name: Power monitoring API reference
+    File: power-monitoring-api-reference
 ---
 Name: Scalability and performance
 Dir: scalability_and_performance

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

@@ -6,7 +6,7 @@
 [id="power-monitoring-about-power-monitoring_{context}"]
 = About {PM-shortname}
 
-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.
+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.
 
 [WARNING]
 ====

modules/power-monitoring-accessing-dashboards-admin.adoc

@@ -6,7 +6,7 @@
 [id="power-monitoring-accessing-dashboards-admin_{context}"]
 = Accessing {PM-shortname} dashboards as a cluster administrator
 
-You can access {PM-shortname} dashboards from the *Administrator* perspective of the {product-title} web console.
+You can access {PM-shortname} dashboards of the {product-title} web console.
 
 .Prerequisites
 
@@ -18,8 +18,8 @@ You can access {PM-shortname} dashboards from the *Administrator* perspective of
 
 .Procedure
 
-. In the *Administrator* perspective of the web console, go to *Observe* -> *Dashboards*.
+. In the web console, go to *Observe* -> *Dashboards*.
 
-. From the *Dashboard* drop-down list, select the {PM-shortname} dashboard you want to see: 
-** *Power Monitoring / Overview*
-** *Power Monitoring / Namespace*
+. From the *Dashboard* drop-down list, select the {PM-shortname} dashboard you want to see:
+** *Power Monitor / Overview*
+** *Power Monitor / Namespace (Pods)*

modules/power-monitoring-accessing-dashboards-developer.adoc

@@ -6,7 +6,7 @@
 [id="power-monitoring-accessing-dashboards-developer_{context}"]
 = Accessing {PM-shortname} dashboards as a developer
 
-You can access {PM-shortname} dashboards from the *Developer* perspective of the {product-title} web console.
+You can access {PM-shortname} dashboards from {product-title} web console.
 
 .Prerequisites
 
@@ -19,7 +19,7 @@ You can access {PM-shortname} dashboards from the *Developer* perspective of the
 
 .Procedure
 
-. In the *Developer* perspective of the web console, go to *Observe* -> *Dashboard*.
+. In the web console, go to *Observe* -> *Dashboard*.
 
 . From the *Dashboard* drop-down list, select the {PM-shortname} dashboard you want to see:
-** *Power Monitoring / Overview*
+** *Power Monitor / Overview*

modules/power-monitoring-api-specifications.adoc

@@ -0,0 +1,153 @@
+// Automatically generated by 'kepler.system.sustainable.computing.io'. Do not edit.
+:_mod-docs-content-type: REFERENCE
+[id="power-monitoring-api-specifications_{context}"]
+= PowerMonitoring API specifications
+
+PowerMonitor
+
+
+PowerMonitor is the schema for the PowerMonitor API.
+
+[cols="1,1,4,1", options="header"]
+|===
+| Name
+| Type
+| Description
+| Required
+
+| *apiVersion*
+| string
+| kepler.system.sustainable.computing.io/v1alpha1
+| true
+
+| *kind*
+| string
+| PowerMonitor
+| true
+
+| object
+| Refer to the Kubernetes API documentation for the fields of the metadata field.
+| true
+
+| *spec*
+| object
+| PowerMonitorSpec defines the desired state of Power Monitor
+| false
+
+| *status*
+| object
+| PowerMonitorStatus defines the observed state of the Power Monitor.
+| false
+|===
+
+== PowerMonitor.spec
+
+PowerMonitorSpec defines the desired state of Power Monitor
+
+[cols="1,1,3,1", options="header"]
+|===
+| Name
+| Type
+| Description
+| Required
+
+| *kepler*
+| object
+|
+| true
+|===
+
+== PowerMonitor.status.conditions
+
+[cols="1,1,4,1", options="header"]
+|===
+| Name
+| Type
+| Description
+| Required
+
+| *lastTransitionTime*
+| string
+| The last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. +
+Format: date-time
+| true
+
+| *message*
+| string
+| A human-readable message indicating details about the transition. This may be an empty string.
+| true
+
+| *reason*
+| string
+| Contains a programmatic identifier indicating the reason for the condition's last transition.
+| true
+
+| *status*
+| string
+| The status of the condition, which can be one of True, False, or Unknown.
+| true
+
+| *type*
+| string
+| The type of Kepler Condition, such as Reconciled or Available.
+| true
+
+| *observedGeneration*
+| integer
+| Represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date. +
+Format: int64 +
+Minimum: 0
+| false
+|===
+
+== PowerMonitor.status.kepler
+
+[cols="1,1,4,1", options="header"]
+|===
+| Name
+| Type
+| Description
+| Required
+
+| *currentNumberScheduled*
+| integer
+| The number of nodes that are running at least one power-monitor pod and are supposed to run it. +
+Format: int32
+| true
+
+| *desiredNumberScheduled*
+| integer
+| The total number of nodes that should be running the power-monitor pod. +
+Format: int32
+| true
+
+| *numberMisscheduled*
+| integer
+| The number of nodes running the power-monitor pod that are not supposed to. +
+Format: int32
+| true
+
+| *numberReady*
+| integer
+| The number of nodes that should be running the power-monitor pod and have at least one pod with a Ready condition. +
+Format: int32
+| true
+
+| *numberAvailable*
+| integer
+| The number of nodes that should be running the power-monitor pod and have at least one pod running and available. +
+Format: int32
+| false
+
+| *numberUnavailable*
+| integer
+| The number of nodes that should be running the power-monitor pod but have no pods running and available. +
+Format: int32
+| false
+
+| *updatedNumberScheduled*
+| integer
+| The total number of nodes that are running an updated power-monitor pod. +
+Format: int32
+| false
+|===

modules/power-monitoring-configuring-kepler-redfish.adoc

@@ -8,38 +8,21 @@
 
 There are two types of {PM-shortname} dashboards. Both provide different levels of details around power consumption metrics for a single cluster:
 
-[discrete]
-== Power Monitoring / Overview dashboard
+[id="power-monitoring-overview-dashboard_{context}"]
+== Power Monitor / Overview dashboard
 
-With this dashboard, you can observe the following information:
+This dashboard allows you to view the following information:
 
-* An aggregated view of CPU architecture and its power source (`rapl-sysfs`, `rapl-msr`, or `estimator`) along with total nodes with this configuration
+Cluster-wide power consumption:: View current total, active, and idle CPU power consumption, grouped by zones.
+Node-level power details:: Analyze historical and current power consumption (total, active, and idle) for individual nodes.
+Hardware information:: Display CPU model and core counts for each node in the cluster.
+Time-series analysis:: Track power consumption trends over time with graphs that can be filtered by node and zone. This provides a comprehensive view of your cluster's energy usage.
 
-* Total energy consumption by a cluster in the last 24 hours (measured in kilowatt-hour)
+[id="power-monitor-namespace-pods-dashboard_{context}"]
+== Power Monitor / Namespace (Pods) dashboard
 
-* The amount of power consumed by the top 10 namespaces in a cluster in the last 24 hours
+This dashboard allows you to monitor and analyze power consumption for Kubernetes namespaces and pods. It provides the following information:
 
-* Detailed node information, such as its CPU architecture and component power source
-
-These features allow you to effectively monitor the energy consumption of the cluster without needing to investigate each namespace separately.
-
-[WARNING]
-====
-Ensure that the *Components Source* column does not display `estimator` as the power source.
-
-.The Detailed Node Information table with `rapl-sysfs` as the component power source
-image::power-monitoring-component-power-source.png[]
-
-If {PM-kepler} is unable to obtain hardware power consumption metrics, the *Components Source* column displays `estimator` as the power source, which is not supported in Technology Preview. If that happens, then the values from the nodes are not accurate.
-====
-
-[discrete]
-== Power Monitoring / Namespace dashboard
-
-This dashboard allows you to view metrics by namespace and pod. You can observe the following information:
-
-* The power consumption metrics, such as consumption in DRAM and PKG
-
-* The energy consumption metrics in the last hour, such as consumption in DRAM and PKG for core and uncore components
-
-This feature allows you to investigate key peaks and easily identify the primary root causes of high consumption.
+Top ten power consuming namespaces:: A real-time table showing the top ten namespaces based on their current power usage. This helps you quickly identify the most resource-intensive workloads.
+Total namespace power consumption:: A historical graph showing the total power consumption of pods within a selected namespace over time, grouped by zone. This helps you see trends and understand an application's or service's total power use.
+Individual pod power consumption:: A detailed graph showing the power consumption of individual pods, so you can analyze them in detail.

modules/power-monitoring-dashboards-overview.adoc

@@ -8,13 +8,18 @@
 
 You can delete {PM-kepler} by removing the {PM-kepler} instance of the `{PM-kepler}` custom resource definition (CRD) from the {product-title} web console.
 
+[IMPORTANT]
+====
+Starting with {PM-title} 0.5 (Technology Preview), use the `PowerMonitor` CRD, and remove all instances of the `Kepler` CRD.
+====
+
 .Prerequisites
 * You have access to the {product-title} web console.
 * You are logged in as a user with the `cluster-admin` role.
 
 .Procedure
 
-. In the *Administrator* perspective of the web console, go to *Operators* -> *Installed Operators*.
+. In the web console, go to *Operators* -> *Installed Operators*.
 
 . Click *{PM-title-c}* from the *Installed Operators* list and go to the *{PM-kepler}* tab.