Skip to content

Commit 40836a6

Browse files
gwynnemonahanopenshift-cherrypick-robot
authored andcommitted
POWERMON-576 0.5 Release Notes
1 parent 9c103dc commit 40836a6

8 files changed

+146
-1
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3289,6 +3289,8 @@ Topics:
32893289
Dir: power_monitoring
32903290
Distros: openshift-enterprise,openshift-origin
32913291
Topics:
3292+
- Name: Power monitoring 0.5 release notes
3293+
File: power-monitoring-release-notes-tp-0-5
32923294
- Name: Power monitoring release notes
32933295
File: power-monitoring-release-notes
32943296
- Name: Power monitoring overview
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// Module included in the following assemblies:
2+
3+
// * power_monitoring/power-monitoring-assembly-tp-0-5-release-notes.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="power-monitoring-0-5-deprecated-removed-features_{context}"]
7+
= Power monitoring 0.5 (Technology Preview) deprecated and removed features
8+
9+
* 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.
10+
11+
* 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.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Module included in the following assemblies:
2+
3+
// * power_monitoring/power-monitoring-tp-0-5-release-notes.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="power-monitoring-tp-0-5-enhancements_{context}"]
7+
= Power monitoring Technology Preview 0.5 enhancements
8+
9+
This release of {PM-title} and the {PM-operator}, based on the Kepler Project, includes the following enhancements:
10+
11+
* Dynamic detection of Nodes Running Average Power Limit (RAPL) zones
12+
* More accurate power measurement based on active CPU usage
13+
* Improved Virtual Machine (VM), container, and pod detection
14+
* More relevant label values for processes, containers, VMs, and pods
15+
* Requires only `readonly` access to host: `/proc` and `/sys`
16+
** No more `CAP_SYSADMIN` and `CAP_BPF`
17+
* Significantly reduced resource usage compared to earlier Kepler implementations
18+
* Multi-level energy tracking for the following levels:
19+
** node
20+
** process
21+
** container
22+
** VM
23+
** pod
24+
* Terminated workload tracking with configurable retention policies
25+
* Energy-based prioritization for terminated resources
26+
* Real-time data collection with configurable intervals and staleness detection
27+
28+
[id="updated-dashboards_{context}"]
29+
== Updated dashboards
30+
31+
With this update, {PM-title} has the following dashboard changes:
32+
33+
* Updated *Power Monitor / Overview* dashboard.
34+
* Updated *Power Monitor / Namespace (Pods)* dashboard.
35+
36+
[IMPORTANT]
37+
====
38+
The older metrics and dashboards are no longer supported. If you are managing your own custom dashboard or queries, you need to update to the newer versions.
39+
====
40+
41+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// Module included in the following assemblies:
2+
3+
// * power_monitoring/power-monitoring-tp-0-5-release-notes.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="power-monitoring-release-notes-tp-0-5-new-features_{context}"]
7+
= Power monitoring Technology Preview 0.5 new features
8+
9+
This release of {PM-title} and the {PM-operator}, based on the Kepler Project, includes the following new feature:
10+
11+
* Deployment and deletion of `PowerMonitor` custom resource definition (CRD).
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Module included in the following assemblies:
2+
3+
// * power_monitoring/power-monitoring-assembly-tp-0-5-release-notes.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="power-monitoring-tp-0-5-overview_{context}"]
7+
= Power monitoring 0.5 (Technology Preview) release notes overview
8+
9+
:FeatureName: Power monitoring
10+
include::snippets/technology-preview.adoc[leveloffset=+2]
11+
12+
{PM-title-c} enables you to monitor the power usage of workloads and identify the most power-consuming namespaces running in an {product-title} cluster with key power consumption metrics, such as CPU or DRAM, measured at container level.
13+
14+
This release of power monitoring and the {PM-operator} provides more accurate data, includes new dashboards, and removes some features and functionality.
15+
16+
This release of power monitoring and the {PM-operator} is supported on:
17+
18+
* {product-title} 4.17+
19+
* Bare metal deployments
20+
21+
//following new release notes template in GDoc from release notes team
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// Module included in the following assemblies:
2+
3+
// * power_monitoring/power-monitoring-assembly-tp-0-5-release-notes.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="power-monitoring-release-notes-tp-0-5-support-tables_{context}"]
7+
= {PM-shortname-c} 0.5 (Technology Preview) support tables
8+
//may need to update the title
9+
This release includes the following support updates:
10+
11+
.Power Monitoring Operator supported version table
12+
[cols="1,1"]
13+
|===
14+
|{PM-kepler}
15+
|0.10.2
16+
|{PM-operator}
17+
|0.20.0
18+
|===
19+
20+
.Power monitoring supported platforms
21+
[cols="1,1"]
22+
|===
23+
|{product-title}
24+
|4.17+
25+
|Bare metal
26+
| X
27+
|===
28+
29+
[IMPORTANT]
30+
====
31+
Installations in virtual machines are not supported and will not function.
32+
====
33+
34+
//* With this update, Red Hat OpenShift power monitoring is only supported on OpenShift Container Platform clusters that are installed on bare metal. Installations in virtual machines are not support and will not function.
35+
//will likely need to create a reference module for a Feature Support Table or some kind for this bullet point on supported cluster installation platforms.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="power-monitoring-assembly-tp-0-5-release-notes_{context}"]
3+
include::_attributes/common-attributes.adoc[]
4+
= {PM-title-c} 0.5 (Technology Preview) release notes
5+
:context: power-monitoring-release-notes
6+
7+
toc::[]
8+
9+
//:FeatureName: Power monitoring
10+
//include::snippets/technology-preview.adoc[leveloffset=+2]
11+
////
12+
{PM-title-c} enables you to monitor the power usage of workloads and identify the most power-consuming namespaces running in an {product-title} cluster with key power consumption metrics, such as CPU or DRAM, measured at container level.
13+
////
14+
These release notes track the development of {PM-title} in the {product-title}.
15+
16+
For an overview of the {PM-operator}, see xref:../power_monitoring/power-monitoring-overview.adoc#power-monitoring-about-power-monitoring_power-monitoring-overview[About {PM-shortname}].
17+
18+
19+
include::modules/power-monitoring-release-notes-tp-0-5-overview.adoc[leveloffset=+1]
20+
include::modules/power-monitoring-release-notes-tp-0-5-new-features.adoc[leveloffset=+2]
21+
include::modules/power-monitoring-release-notes-tp-0-5-enhancements.adoc[leveloffset=+2]
22+
include::modules/power-monitoring-release-notes-tp-0-5-deprecated-removed-features.adoc[leveloffset=+2]
23+
include::modules/power-monitoring-release-notes-tp-0-5-support-tables.adoc[leveloffset=+2]

observability/power_monitoring/power-monitoring-release-notes.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ These release notes track the development of {PM-title} in the {product-title}.
1515

1616
For an overview of the {PM-operator}, see xref:../power_monitoring/power-monitoring-overview.adoc#power-monitoring-about-power-monitoring_power-monitoring-overview[About {PM-shortname}].
1717

18+
1819
[id="power-monitoring-release-notes-0-4_{context}"]
1920
== {PM-shortname-c} 0.4 (Technology Preview)
2021

@@ -118,7 +119,7 @@ This release introduces a Technology Preview version of {PM-title}. The followin
118119

119120
[id="power-monitoring-release-notes-0-1-features"]
120121
=== Features
121-
* Deployment and deletion of {PM-kepler}
122+
* Deployment and deletion of {PM-kepler}
122123
* Power usage metrics from Intel-based bare-metal deployments
123124
* Dashboards for plotting power usage
124125

0 commit comments

Comments
 (0)