[POWERMON] POWERMON-629 API Spec TP 0.5

_topic_maps/_topic_map.yml

@@ -3300,6 +3300,8 @@ Topics:
     File: visualizing-power-monitoring-metrics
   - Name: Uninstalling power monitoring
     File: uninstalling-power-monitoring
+  - Name: Power monitoring API reference
+    File: power-monitoring-api-reference
 ---
 Name: Scalability and performance
 Dir: scalability_and_performance

modules/power-monitoring-api-specifications.adoc

@@ -0,0 +1,137 @@
+// 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
+
+| link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#objectmeta-v1-meta[*metadata*]
+| object
+| Refer to the Kubernetes API documentation for the fields of the metadata field.
+| true
+
+| *spec*
+| object
+| PowerMonitorSpec defines the desired state of the Power Monitor.
+| false
+
+| *status*
+| object
+| PowerMonitorStatus defines the observed state of the Power Monitor.
+| false
+|===
+
+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
+|===

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

@@ -0,0 +1,14 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="power-monitoring-api-reference_{context}"]
+= Power monitoring API reference
+include::_attributes/common-attributes.adoc[]
+:context: power-monitoring-kepler-power-attribution-guide
+
+toc::[]
+
+:FeatureName: Power monitoring
+include::snippets/technology-preview.adoc[leveloffset=+2]
+
+PowerMonitor is the Schema for the PowerMonitor API.
+
+include::modules/power-monitoring-api-specifications.adoc[leveloffset=+1]