feat: Add cluster config endpoint to rest api

ClusterCockpit · Mar 8, 2024 · 99d55f0 · 99d55f0
1 parent 9fd839f
commit 99d55f0
Show file tree

Hide file tree

Showing 4 changed files with 756 additions and 4 deletions.
diff --git a/api/swagger.json b/api/swagger.json
@@ -17,6 +17,63 @@
     "host": "localhost:8080",
     "basePath": "/api",
     "paths": {
+        "/clusters/": {
+            "get": {
+                "security": [
+                    {
+                        "ApiKeyAuth": []
+                    }
+                ],
+                "description": "Get a list of all cluster configs. Specific cluster can be requested using query parameter.",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Cluster query"
+                ],
+                "summary": "Lists all cluster configs",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Job Cluster",
+                        "name": "cluster",
+                        "in": "query"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Array of clusters",
+                        "schema": {
+                            "$ref": "#/definitions/api.GetClustersApiResponse"
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/api.ErrorResponse"
+                        }
+                    },
+                    "401": {
+                        "description": "Unauthorized",
+                        "schema": {
+                            "$ref": "#/definitions/api.ErrorResponse"
+                        }
+                    },
+                    "403": {
+                        "description": "Forbidden",
+                        "schema": {
+                            "$ref": "#/definitions/api.ErrorResponse"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/api.ErrorResponse"
+                        }
+                    }
+                }
+            }
+        },
         "/jobs/": {
             "get": {
                 "security": [
@@ -1284,6 +1341,18 @@
                 }
             }
         },
+        "api.GetClustersApiResponse": {
+            "type": "object",
+            "properties": {
+                "clusters": {
+                    "description": "Array of clusters",
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/schema.Cluster"
+                    }
+                }
+            }
+        },
         "api.GetJobApiResponse": {
             "type": "object",
             "properties": {
@@ -1379,6 +1448,40 @@
                 }
             }
         },
+        "schema.Accelerator": {
+            "type": "object",
+            "properties": {
+                "id": {
+                    "type": "string"
+                },
+                "model": {
+                    "type": "string"
+                },
+                "type": {
+                    "type": "string"
+                }
+            }
+        },
+        "schema.Cluster": {
+            "type": "object",
+            "properties": {
+                "metricConfig": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/schema.MetricConfig"
+                    }
+                },
+                "name": {
+                    "type": "string"
+                },
+                "subClusters": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/schema.SubCluster"
+                    }
+                }
+            }
+        },
         "schema.Job": {
             "description": "Information of a HPC job.",
             "type": "object",
@@ -1777,6 +1880,44 @@
                 }
             }
         },
+        "schema.MetricConfig": {
+            "type": "object",
+            "properties": {
+                "aggregation": {
+                    "type": "string"
+                },
+                "alert": {
+                    "type": "number"
+                },
+                "caution": {
+                    "type": "number"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "normal": {
+                    "type": "number"
+                },
+                "peak": {
+                    "type": "number"
+                },
+                "scope": {
+                    "$ref": "#/definitions/schema.MetricScope"
+                },
+                "subClusters": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/schema.SubClusterConfig"
+                    }
+                },
+                "timestep": {
+                    "type": "integer"
+                },
+                "unit": {
+                    "$ref": "#/definitions/schema.Unit"
+                }
+            }
+        },
         "schema.MetricScope": {
             "type": "string",
             "enum": [
@@ -1812,6 +1953,17 @@
                 }
             }
         },
+        "schema.MetricValue": {
+            "type": "object",
+            "properties": {
+                "unit": {
+                    "$ref": "#/definitions/schema.Unit"
+                },
+                "value": {
+                    "type": "number"
+                }
+            }
+        },
         "schema.Resource": {
             "description": "A resource used by a job",
             "type": "object",
@@ -1892,6 +2044,64 @@
                 }
             }
         },
+        "schema.SubCluster": {
+            "type": "object",
+            "properties": {
+                "coresPerSocket": {
+                    "type": "integer"
+                },
+                "flopRateScalar": {
+                    "$ref": "#/definitions/schema.MetricValue"
+                },
+                "flopRateSimd": {
+                    "$ref": "#/definitions/schema.MetricValue"
+                },
+                "memoryBandwidth": {
+                    "$ref": "#/definitions/schema.MetricValue"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "nodes": {
+                    "type": "string"
+                },
+                "processorType": {
+                    "type": "string"
+                },
+                "socketsPerNode": {
+                    "type": "integer"
+                },
+                "threadsPerCore": {
+                    "type": "integer"
+                },
+                "topology": {
+                    "$ref": "#/definitions/schema.Topology"
+                }
+            }
+        },
+        "schema.SubClusterConfig": {
+            "type": "object",
+            "properties": {
+                "alert": {
+                    "type": "number"
+                },
+                "caution": {
+                    "type": "number"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "normal": {
+                    "type": "number"
+                },
+                "peak": {
+                    "type": "number"
+                },
+                "remove": {
+                    "type": "boolean"
+                }
+            }
+        },
         "schema.Tag": {
             "description": "Defines a tag using name and type.",
             "type": "object",
@@ -1912,6 +2122,59 @@
                 }
             }
         },
+        "schema.Topology": {
+            "type": "object",
+            "properties": {
+                "accelerators": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/schema.Accelerator"
+                    }
+                },
+                "core": {
+                    "type": "array",
+                    "items": {
+                        "type": "array",
+                        "items": {
+                            "type": "integer"
+                        }
+                    }
+                },
+                "die": {
+                    "type": "array",
+                    "items": {
+                        "type": "array",
+                        "items": {
+                            "type": "integer"
+                        }
+                    }
+                },
+                "memoryDomain": {
+                    "type": "array",
+                    "items": {
+                        "type": "array",
+                        "items": {
+                            "type": "integer"
+                        }
+                    }
+                },
+                "node": {
+                    "type": "array",
+                    "items": {
+                        "type": "integer"
+                    }
+                },
+                "socket": {
+                    "type": "array",
+                    "items": {
+                        "type": "array",
+                        "items": {
+                            "type": "integer"
+                        }
+                    }
+                }
+            }
+        },
         "schema.Unit": {
             "type": "object",
             "properties": {