node-red-contrib-oscar-cluster-summary/README.md

The fundamental characteristics of an OSCAR cluster are obtained through the OSCAR API.

# Node-RED OSCAR Cluster Nodes

This library provides Node-RED nodes to interact with the [OSCAR API](https://docs.oscar.grycap.net/latest/api/), enabling monitoring and management of OSCAR clusters from.

---


## Cluster Information Endpoints

These endpoints allow retrieving general information, status, and configuration details from an OSCAR cluster.

---


### Info -- `/system/info`

Returns general information about the OSCAR cluster.

#### Example response:
```json
{
  "version": "string",
  "git_commit": "string",
  "architecture": "string",
  "kubernetes_version": "string",
  "serverless_backend": {
    "name": "string",
    "version": "string"
  }
}
```
---


### Config -- `/system/config`

Returns the cluster configuration regarding:

#### Example response:
```json
{ 
  "minio_provider": { 
    "endpoint": "string", 
    "region": "string", 
    "secret_key": "string", 
    "access_key": "string", 
    "verify": true 
  }, 
  "name": "string", 
  "namespace": "string", 
  "gpu_avaliable": true, 
  "serverless_backend": "string", 
  "yunikorn_enable": true, 
  "oidc_groups": [ 
    "string" 
  ]
}
```

---


### Status -- `/system/status`

Returns the characteristics in terms of CPU and memory (e.g., cluster node RAM, CPU usage, etc.).

---


### Health -- `/system/health`

Returns "OK" if the cluster is functioning correctly.