diff options
| author | Dante Niewenhuis <d.niewenhuis@hotmail.com> | 2024-02-16 13:12:26 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-02-16 13:12:26 +0100 |
| commit | 29f3fd2f2b88b68524e54b9ed00cce5fd6b6c949 (patch) | |
| tree | d5f0f7461de171a149ea3660a9472824d7ab70e1 /opendc-compute/opendc-compute-telemetry/src | |
| parent | 10c47102d6133b86e4c39df96fd25a91010a9864 (diff) | |
Added documentation for input and output (#203)
* Started with a documentation page
* Started with a documentation page
* Added documentation of the input required to run OpenDC, and the output returned by OpenDC to the website.
Diffstat (limited to 'opendc-compute/opendc-compute-telemetry/src')
3 files changed, 3 insertions, 3 deletions
diff --git a/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/HostTableReader.kt b/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/HostTableReader.kt index 63ddcfe1..9af0a0c0 100644 --- a/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/HostTableReader.kt +++ b/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/HostTableReader.kt @@ -109,7 +109,7 @@ public interface HostTableReader { public val powerDraw: Double /** - * The total energy consumption of the host since last time in J. + * The total energy consumption of the host since last sample in J. */ public val energyUsage: Double diff --git a/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/ServerTableReader.kt b/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/ServerTableReader.kt index 1d1ecd10..ec9743d8 100644 --- a/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/ServerTableReader.kt +++ b/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/ServerTableReader.kt @@ -69,7 +69,7 @@ public interface ServerTableReader { public val bootTime: Instant? /** - * The capacity of the CPUs of the servers (in MHz). + * The capacity of the CPUs of Host on which the server is running (in MHz). */ public val cpuLimit: Double diff --git a/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/ServiceTableReader.kt b/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/ServiceTableReader.kt index 90b0c6ea..501e317c 100644 --- a/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/ServiceTableReader.kt +++ b/opendc-compute/opendc-compute-telemetry/src/main/kotlin/org/opendc/compute/telemetry/table/ServiceTableReader.kt @@ -49,7 +49,7 @@ public interface ServiceTableReader { public val hostsDown: Int /** - * The number of servers that are registered with the compute service.. + * The number of servers that are registered with the compute service. */ public val serversTotal: Int |