Skip to content

Commit 81a0bc5

Browse files
gwynnemonahaneromanova97
gwynnemonahan
authored and
eromanova97
committed
[POWERMON] POWERMON-629 API Sepc TP 0.5
1 parent dd47f81 commit 81a0bc5

File tree

3 files changed

+169
-0
lines changed

3 files changed

+169
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3306,6 +3306,8 @@ Topics:
33063306
File: uninstalling-power-monitoring
33073307
- Name: Power monitoring references
33083308
File: power-monitoring-references
3309+
- Name: Power monitoring API reference
3310+
File: power-monitoring-api-reference
33093311
---
33103312
Name: Scalability and performance
33113313
Dir: scalability_and_performance

‎modules/power-monitoring-api-specifications.adoc

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
// Automatically generated by 'kepler.system.sustainable.computing.io'. Do not edit.
2+
:_mod-docs-content-type: REFERENCE
3+
[id="power-monitoring-api-specifications_{context}"]
4+
= PowerMonitoring API specifications
5+
6+
PowerMonitor
7+
8+
9+
PowerMonitor is the schema for the PowerMonitor API.
10+
11+
[cols="1,1,4,1", options="header"]
12+
|===
13+
| Name
14+
| Type
15+
| Description
16+
| Required
17+
18+
| *apiVersion*
19+
| string
20+
| kepler.system.sustainable.computing.io/v1alpha1
21+
| true
22+
23+
| *kind*
24+
| string
25+
| PowerMonitor
26+
| true
27+
28+
| object
29+
| Refer to the Kubernetes API documentation for the fields of the metadata field.
30+
| true
31+
32+
| *spec*
33+
| object
34+
| PowerMonitorSpec defines the desired state of Power Monitor
35+
| false
36+
37+
| *status*
38+
| object
39+
| PowerMonitorStatus defines the observed state of the Power Monitor.
40+
| false
41+
|===
42+
43+
== PowerMonitor.spec
44+
45+
PowerMonitorSpec defines the desired state of Power Monitor
46+
47+
[cols="1,1,3,1", options="header"]
48+
|===
49+
| Name
50+
| Type
51+
| Description
52+
| Required
53+
54+
| *kepler*
55+
| object
56+
|
57+
| true
58+
|===
59+
60+
== PowerMonitor.status.conditions
61+
62+
[cols="1,1,4,1", options="header"]
63+
|===
64+
| Name
65+
| Type
66+
| Description
67+
| Required
68+
69+
| *lastTransitionTime*
70+
| string
71+
| 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. +
72+
Format: date-time
73+
| true
74+
75+
| *message*
76+
| string
77+
| A human-readable message indicating details about the transition. This may be an empty string.
78+
| true
79+
80+
| *reason*
81+
| string
82+
| Contains a programmatic identifier indicating the reason for the condition's last transition.
83+
| true
84+
85+
| *status*
86+
| string
87+
| The status of the condition, which can be one of True, False, or Unknown.
88+
| true
89+
90+
| *type*
91+
| string
92+
| The type of Kepler Condition, such as Reconciled or Available.
93+
| true
94+
95+
| *observedGeneration*
96+
| integer
97+
| 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. +
98+
Format: int64 +
99+
Minimum: 0
100+
| false
101+
|===
102+
103+
== PowerMonitor.status.kepler
104+
105+
[cols="1,1,4,1", options="header"]
106+
|===
107+
| Name
108+
| Type
109+
| Description
110+
| Required
111+
112+
| *currentNumberScheduled*
113+
| integer
114+
| The number of nodes that are running at least one power-monitor pod and are supposed to run it. +
115+
Format: int32
116+
| true
117+
118+
| *desiredNumberScheduled*
119+
| integer
120+
| The total number of nodes that should be running the power-monitor pod. +
121+
Format: int32
122+
| true
123+
124+
| *numberMisscheduled*
125+
| integer
126+
| The number of nodes running the power-monitor pod that are not supposed to. +
127+
Format: int32
128+
| true
129+
130+
| *numberReady*
131+
| integer
132+
| The number of nodes that should be running the power-monitor pod and have at least one pod with a Ready condition. +
133+
Format: int32
134+
| true
135+
136+
| *numberAvailable*
137+
| integer
138+
| The number of nodes that should be running the power-monitor pod and have at least one pod running and available. +
139+
Format: int32
140+
| false
141+
142+
| *numberUnavailable*
143+
| integer
144+
| The number of nodes that should be running the power-monitor pod but have no pods running and available. +
145+
Format: int32
146+
| false
147+
148+
| *updatedNumberScheduled*
149+
| integer
150+
| The total number of nodes that are running an updated power-monitor pod. +
151+
Format: int32
152+
| false
153+
|===

‎observability/power_monitoring/power-monitoring-api-reference.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="power-monitoring-api-reference_{context}"]
3+
= Power monitoring API reference
4+
include::_attributes/common-attributes.adoc[]
5+
:context: power-monitoring-kepler-power-attribution-guide
6+
7+
toc::[]
8+
9+
:FeatureName: Power monitoring
10+
include::snippets/technology-preview.adoc[leveloffset=+2]
11+
12+
PowerMonitor is the Schema for the PowerMonitor API.
13+
14+
include::modules/power-monitoring-api-specifications.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)