summaryrefslogtreecommitdiff
path: root/site
diff options
context:
space:
mode:
Diffstat (limited to 'site')
-rw-r--r--site/docs/documentation/Input/Topology.md12
-rw-r--r--site/docs/documentation/Input/TopologySchema.md300
2 files changed, 154 insertions, 158 deletions
diff --git a/site/docs/documentation/Input/Topology.md b/site/docs/documentation/Input/Topology.md
index 8a57a183..23286c09 100644
--- a/site/docs/documentation/Input/Topology.md
+++ b/site/docs/documentation/Input/Topology.md
@@ -17,12 +17,12 @@ In the following section, we describe the different components of the schema.
### Host
-| variable | type | required? | default | description |
-|-------------|-----------------------------|-----------|---------|--------------------------------------------------------------------------------|
-| name | string | no | Host | The name of the host. This is only important for debugging and post-processing |
-| count | integer | no | 1 | The amount of hosts of this type are in the cluster |
-| cpus | List[[CPU](#cpu)] | yes | N/A | A list of the hosts in a cluster. |
-| memory | [Memory](#memory) | yes | N/A | The memory used by the host |
+| variable | type | required? | default | description |
+|------------|-----------------------|-----------|---------|--------------------------------------------------------------------------------|
+| name | string | no | Host | The name of the host. This is only important for debugging and post-processing |
+| count | integer | no | 1 | The amount of hosts of this type are in the cluster |
+| cpu | [CPU](#cpu) | yes | N/A | The CPUs in the host |
+| memory | [Memory](#memory) | yes | N/A | The memory used by the host |
| power model | [Power Model](#power-model) | yes | N/A | The power model used to determine the power draw of the host |
### CPU
diff --git a/site/docs/documentation/Input/TopologySchema.md b/site/docs/documentation/Input/TopologySchema.md
index d8d3aa48..9c4e0c40 100644
--- a/site/docs/documentation/Input/TopologySchema.md
+++ b/site/docs/documentation/Input/TopologySchema.md
@@ -3,162 +3,158 @@ A topology file can be validated using a JSON schema validator, such as https://
```json
{
- "$schema": "OpenDC/Topology",
- "$defs": {
- "cpu": {
- "description": "definition of a cpu",
- "type": "object",
- "properties": {
- "vendor": {
- "type": "string",
- "default": "unknown"
- },
- "modelName": {
- "type": "string",
- "default": "unknown"
- },
- "arch": {
- "type": "string",
- "default": "unknown"
- },
- "coreCount": {
- "type": "integer"
- },
- "coreSpeed": {
- "description": "The core speed of the cpu in Mhz",
- "type": "number"
- },
- "count": {
- "description": "The amount CPUs of this type present in the cluster",
- "type": "integer"
- }
- },
- "required": [
- "coreCount",
- "coreSpeed"
- ]
- },
- "memory": {
- "type": "object",
- "properties": {
- "vendor": {
- "type": "string",
- "default": "unknown"
- },
- "modelName": {
- "type": "string",
- "default": "unknown"
- },
- "arch": {
- "type": "string",
- "default": "unknown"
- },
- "memorySize": {
- "description": "The amount of the memory in B",
- "type": "integer"
- },
- "memorySpeed": {
- "description": "The speed of the memory in Mhz. Note: currently, this does nothing",
- "type": "number",
- "default": -1
- }
- },
- "required": [
- "memorySize"
- ]
- },
- "powerModel": {
- "type": "object",
- "properties": {
- "modelType": {
- "description": "The type of model used to determine power draw",
- "type": "string"
- },
- "power": {
- "description": "The constant power draw when using the 'constant' power model type in Watt",
- "type": "number",
- "default": 400
- },
- "maxPower": {
- "description": "The power draw of a host when idle in Watt",
- "type": "number"
- },
- "idlePower": {
- "description": "The power draw of a host when using max capacity in Watt",
- "type": "number"
- }
- },
- "required": [
- "modelType",
- "maxPower",
- "idlePower"
- ]
- },
- "host": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "default": "Host"
- },
- "count": {
- "description": "The amount hosts of this type present in the cluster",
- "type": "integer",
- "default": 1
- },
- "cpus": {
- "type": "array",
- "items": {
- "$ref": "#/$defs/cpu"
- },
- "minItems": 1
+ "$schema": "OpenDC/Topology",
+ "$defs": {
+ "cpu": {
+ "description": "definition of a cpu",
+ "type": "object",
+ "properties": {
+ "vendor": {
+ "type": "string",
+ "default": "unknown"
+ },
+ "modelName": {
+ "type": "string",
+ "default": "unknown"
+ },
+ "arch": {
+ "type": "string",
+ "default": "unknown"
+ },
+ "coreCount": {
+ "type": "integer"
+ },
+ "coreSpeed": {
+ "description": "The core speed of the cpu in Mhz",
+ "type": "number"
+ },
+ "count": {
+ "description": "The amount CPUs of this type present in the cluster",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "coreCount",
+ "coreSpeed"
+ ]
},
"memory": {
- "$ref": "#/$defs/memory"
+ "type": "object",
+ "properties": {
+ "vendor": {
+ "type": "string",
+ "default": "unknown"
+ },
+ "modelName": {
+ "type": "string",
+ "default": "unknown"
+ },
+ "arch": {
+ "type": "string",
+ "default": "unknown"
+ },
+ "memorySize": {
+ "description": "The amount of the memory in B",
+ "type": "integer"
+ },
+ "memorySpeed": {
+ "description": "The speed of the memory in Mhz. Note: currently, this does nothing",
+ "type": "number",
+ "default": -1
+ }
+ },
+ "required": [
+ "memorySize"
+ ]
+ },
+ "powerModel": {
+ "type": "object",
+ "properties": {
+ "modelType": {
+ "description": "The type of model used to determine power draw",
+ "type": "string"
+ },
+ "power": {
+ "description": "The constant power draw when using the 'constant' power model type in Watt",
+ "type": "number",
+ "default": 400
+ },
+ "maxPower": {
+ "description": "The power draw of a host when idle in Watt",
+ "type": "number"
+ },
+ "idlePower": {
+ "description": "The power draw of a host when using max capacity in Watt",
+ "type": "number"
+ }
+ },
+ "required": [
+ "modelType",
+ "maxPower",
+ "idlePower"
+ ]
+ },
+ "host": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "default": "Host"
+ },
+ "count": {
+ "description": "The amount hosts of this type present in the cluster",
+ "type": "integer",
+ "default": 1
+ },
+ "cpu": {
+ "$ref": "#/$defs/cpu"
+ },
+ "memory": {
+ "$ref": "#/$defs/memory"
+ }
+ },
+ "required": [
+ "cpu",
+ "memory"
+ ]
+ },
+ "cluster": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "default": "Cluster"
+ },
+ "count": {
+ "description": "The amount clusters of this type present in the Data center",
+ "type": "integer",
+ "default": 1
+ },
+ "hosts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/$defs/host"
+ },
+ "minItems": 1
+ }
+ },
+ "required": [
+ "hosts"
+ ]
}
- },
- "required": [
- "cpus",
- "memory"
- ]
},
- "cluster": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "default": "Cluster"
- },
- "count": {
- "description": "The amount clusters of this type present in the Data center",
- "type": "integer",
- "default": 1
- },
- "hosts": {
- "type": "array",
- "items": {
- "$ref": "#/$defs/host"
- },
- "minItems": 1
+ "properties": {
+ "clusters": {
+ "description": "Clusters present in the data center",
+ "type": "array",
+ "items": {
+ "$ref": "#/$defs/cluster"
+ },
+ "minItems": 1
}
- },
- "required": [
- "hosts"
- ]
- }
- },
- "properties": {
- "clusters": {
- "description": "Clusters present in the data center",
- "type": "array",
- "items": {
- "$ref": "#/$defs/cluster"
- },
- "minItems": 1
- }
- },
- "required": [
- "clusters"
- ]
+ },
+ "required": [
+ "clusters"
+ ]
}
```
generated by cgit v1.2.3 (git 2.25.1) at 2026-02-04 14:15:23 +0000