diff options
Diffstat (limited to 'site/docs/documentation/Input/TopologySchema.md')
| -rw-r--r-- | site/docs/documentation/Input/TopologySchema.md | 160 |
1 files changed, 0 insertions, 160 deletions
diff --git a/site/docs/documentation/Input/TopologySchema.md b/site/docs/documentation/Input/TopologySchema.md deleted file mode 100644 index d0199568..00000000 --- a/site/docs/documentation/Input/TopologySchema.md +++ /dev/null @@ -1,160 +0,0 @@ -Below is the schema for the Topology JSON file. This schema can be used to validate a topology file. -A topology file can be validated using a JSON schema validator, such as https://www.jsonschemavalidator.net/. - -```json -{ - "$schema": "OpenDC/Topology", - "$defs": { - "cpuModel": { - "description": "definition of a cpuModel", - "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 cpuModel 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 - }, - "cpuModel": { - "$ref": "#/$defs/cpuModel" - }, - "memory": { - "$ref": "#/$defs/memory" - } - }, - "required": [ - "cpuModel", - "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" - ] - } - }, - "properties": { - "clusters": { - "description": "Clusters present in the data center", - "type": "array", - "items": { - "$ref": "#/$defs/cluster" - }, - "minItems": 1 - } - }, - "required": [ - "clusters" - ] -} -``` |
