Cluster Schema
ClusterCockpit Cluster Schema Reference
The following schema in its raw form can be found in the ClusterCockpit GitHub repository.
Manual Updates
Changes to the original JSON schema found in the repository are not automatically rendered in this reference documentation.Last Update: 02.02.2024HPC cluster description
Title: HPC cluster description
Description: Meta data information of a HPC cluster
1. [Required] Property HPC cluster description > name
Description: The unique identifier of a cluster
2. [Required] Property HPC cluster description > metricConfig
| |
|---|
| Type | array of object |
| Required | Yes |
Description: Metric specifications
| Array restrictions |
|---|
| Min items | 1 |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
2.1. HPC cluster description > metricConfig > metricConfig items
2.1.1. [Required] Property HPC cluster description > metricConfig > metricConfig items > name
Description: Metric name
2.1.2. [Required] Property HPC cluster description > metricConfig > metricConfig items > unit
Description: Metric unit
2.1.2.1. [Required] Property HPC cluster description > metricConfig > metricConfig items > unit > base
| |
|---|
| Type | enum (of string) |
| Required | Yes |
Description: Metric base unit
Must be one of:
- “B”
- “F”
- “B/s”
- “F/s”
- “CPI”
- “IPC”
- “Hz”
- “W”
- “°C”
- ""
2.1.2.2. [Optional] Property HPC cluster description > metricConfig > metricConfig items > unit > prefix
| |
|---|
| Type | enum (of string) |
| Required | No |
Description: Unit prefix
Must be one of:
2.1.3. [Required] Property HPC cluster description > metricConfig > metricConfig items > scope
Description: Native measurement resolution
2.1.4. [Required] Property HPC cluster description > metricConfig > metricConfig items > timestep
Description: Frequency of timeseries points
2.1.5. [Required] Property HPC cluster description > metricConfig > metricConfig items > aggregation
| |
|---|
| Type | enum (of string) |
| Required | Yes |
Description: How the metric is aggregated
Must be one of:
2.1.6. [Required] Property HPC cluster description > metricConfig > metricConfig items > peak
Description: Metric peak threshold (Upper metric limit)
2.1.7. [Required] Property HPC cluster description > metricConfig > metricConfig items > normal
Description: Metric normal threshold
2.1.8. [Required] Property HPC cluster description > metricConfig > metricConfig items > caution
Description: Metric caution threshold (Suspicious but does not require immediate action)
2.1.9. [Required] Property HPC cluster description > metricConfig > metricConfig items > alert
Description: Metric alert threshold (Requires immediate action)
2.1.10. [Optional] Property HPC cluster description > metricConfig > metricConfig items > subClusters
| |
|---|
| Type | array of object |
| Required | No |
Description: Array of cluster hardware partition metric thresholds
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
2.1.10.1. HPC cluster description > metricConfig > metricConfig items > subClusters > subClusters items
2.1.10.1.1. [Required] Property HPC cluster description > metricConfig > metricConfig items > subClusters > subClusters items > name
Description: Hardware partition name
2.1.10.1.2. [Optional] Property HPC cluster description > metricConfig > metricConfig items > subClusters > subClusters items > peak
2.1.10.1.3. [Optional] Property HPC cluster description > metricConfig > metricConfig items > subClusters > subClusters items > normal
2.1.10.1.4. [Optional] Property HPC cluster description > metricConfig > metricConfig items > subClusters > subClusters items > caution
2.1.10.1.5. [Optional] Property HPC cluster description > metricConfig > metricConfig items > subClusters > subClusters items > alert
2.1.10.1.6. [Optional] Property HPC cluster description > metricConfig > metricConfig items > subClusters > subClusters items > remove
3. [Required] Property HPC cluster description > subClusters
| |
|---|
| Type | array of object |
| Required | Yes |
Description: Array of cluster hardware partitions
| Array restrictions |
|---|
| Min items | 1 |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
3.1. HPC cluster description > subClusters > subClusters items
3.1.1. [Required] Property HPC cluster description > subClusters > subClusters items > name
Description: Hardware partition name
3.1.2. [Required] Property HPC cluster description > subClusters > subClusters items > processorType
Description: Processor type
3.1.3. [Required] Property HPC cluster description > subClusters > subClusters items > socketsPerNode
Description: Number of sockets per node
3.1.4. [Required] Property HPC cluster description > subClusters > subClusters items > coresPerSocket
Description: Number of cores per socket
3.1.5. [Required] Property HPC cluster description > subClusters > subClusters items > threadsPerCore
Description: Number of SMT threads per core
3.1.6. [Required] Property HPC cluster description > subClusters > subClusters items > flopRateScalar
Description: Theoretical node peak flop rate for scalar code in GFlops/s
3.1.6.1. [Optional] Property HPC cluster description > subClusters > subClusters items > flopRateScalar > unit
Description: Metric unit
3.1.6.2. [Optional] Property HPC cluster description > subClusters > subClusters items > flopRateScalar > value
3.1.7. [Required] Property HPC cluster description > subClusters > subClusters items > flopRateSimd
Description: Theoretical node peak flop rate for SIMD code in GFlops/s
3.1.7.1. [Optional] Property HPC cluster description > subClusters > subClusters items > flopRateSimd > unit
Description: Metric unit
3.1.7.2. [Optional] Property HPC cluster description > subClusters > subClusters items > flopRateSimd > value
3.1.8. [Required] Property HPC cluster description > subClusters > subClusters items > memoryBandwidth
Description: Theoretical node peak memory bandwidth in GB/s
3.1.8.1. [Optional] Property HPC cluster description > subClusters > subClusters items > memoryBandwidth > unit
Description: Metric unit
3.1.8.2. [Optional] Property HPC cluster description > subClusters > subClusters items > memoryBandwidth > value
3.1.9. [Required] Property HPC cluster description > subClusters > subClusters items > nodes
Description: Node list expression
3.1.10. [Required] Property HPC cluster description > subClusters > subClusters items > topology
Description: Node topology
3.1.10.1. [Required] Property HPC cluster description > subClusters > subClusters items > topology > node
| |
|---|
| Type | array of integer |
| Required | Yes |
Description: HwTread lists of node
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| node items | - |
3.1.10.1.1. HPC cluster description > subClusters > subClusters items > topology > node > node items
3.1.10.2. [Required] Property HPC cluster description > subClusters > subClusters items > topology > socket
| |
|---|
| Type | array of array |
| Required | Yes |
Description: HwTread lists of sockets
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
3.1.10.2.1. HPC cluster description > subClusters > subClusters items > topology > socket > socket items
| |
|---|
| Type | array of integer |
| Required | No |
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
3.1.10.2.1.1. HPC cluster description > subClusters > subClusters items > topology > socket > socket items > socket items items
3.1.10.3. [Required] Property HPC cluster description > subClusters > subClusters items > topology > memoryDomain
| |
|---|
| Type | array of array |
| Required | Yes |
Description: HwTread lists of memory domains
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
3.1.10.3.1. HPC cluster description > subClusters > subClusters items > topology > memoryDomain > memoryDomain items
| |
|---|
| Type | array of integer |
| Required | No |
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
3.1.10.3.1.1. HPC cluster description > subClusters > subClusters items > topology > memoryDomain > memoryDomain items > memoryDomain items items
3.1.10.4. [Optional] Property HPC cluster description > subClusters > subClusters items > topology > die
| |
|---|
| Type | array of array |
| Required | No |
Description: HwTread lists of dies
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| die items | - |
3.1.10.4.1. HPC cluster description > subClusters > subClusters items > topology > die > die items
| |
|---|
| Type | array of integer |
| Required | No |
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
3.1.10.4.1.1. HPC cluster description > subClusters > subClusters items > topology > die > die items > die items items
3.1.10.5. [Optional] Property HPC cluster description > subClusters > subClusters items > topology > core
| |
|---|
| Type | array of array |
| Required | No |
Description: HwTread lists of cores
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|
| core items | - |
3.1.10.5.1. HPC cluster description > subClusters > subClusters items > topology > core > core items
| |
|---|
| Type | array of integer |
| Required | No |
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
3.1.10.5.1.1. HPC cluster description > subClusters > subClusters items > topology > core > core items > core items items
3.1.10.6. [Optional] Property HPC cluster description > subClusters > subClusters items > topology > accelerators
| |
|---|
| Type | array of object |
| Required | No |
Description: List of of accelerator devices
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
3.1.10.6.1. HPC cluster description > subClusters > subClusters items > topology > accelerators > accelerators items
3.1.10.6.1.1. [Required] Property HPC cluster description > subClusters > subClusters items > topology > accelerators > accelerators items > id
Description: The unique device id
3.1.10.6.1.2. [Required] Property HPC cluster description > subClusters > subClusters items > topology > accelerators > accelerators items > type
| |
|---|
| Type | enum (of string) |
| Required | Yes |
Description: The accelerator type
Must be one of:
- “Nvidia GPU”
- “AMD GPU”
- “Intel GPU”
3.1.10.6.1.3. [Required] Property HPC cluster description > subClusters > subClusters items > topology > accelerators > accelerators items > model
Description: The accelerator model
Generated using json-schema-for-humans on 2024-02-02 at 14:36:54 +0100