Returns the specified cluster summary overview

GET 
/v1/dashboard/spectroclusters/:uid/overview

Returns the specified cluster summary overview

Request

Path Parameters

uid stringrequired

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

An spectro cluster summary overview

application/json

Schema

Schema

metadata object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations object

Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels object

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name of the resource

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

Populated by the system. Read-only.

spec object
Spectro cluster spec summary
archTypesstring[]
Possible values: [amd64, arm64]
Architecture types of the cluster
cloudConfig object
cloudTypestring
Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]
Default value: all
machinePools object[]
Machine pool meta information
Array [
cloudTypestring
Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]
Default value: all
healthyint32
number of healthy machines
infraProfileTemplate object
InfraClusterProfile contains OS/Kernel for this NodePool
cloudTypestring
Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]
Default value: all
namestring
Cluster profile name
packs object[]
Cluster profile packs array
Array [
annotations object
Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml
property name*string
digeststring
digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade
inValidReasonstring
isInvalidboolean
pack is invalid when the associated tag is deleted from the registry
layerstringrequired
Possible values: [kernel, os, k8s, cni, csi, addon]
manifests object[]
Array [
kindstring
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
namestring
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
uidstring
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
]
namestringrequired
pack name
packUidstring
PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.
params object
params passed as env variables to be consumed at installation time
property name*string
presets object[]
Array [
addstring
displayNamestring
groupstring
namestring
removestring[]
]
registryUidstring
pack registry uid
schema object[]
Array [
formatstring
hintsstring[]
listOptionsstring[]
namestring
readonlyboolean
regexstring
requiredboolean
typestring
]
serverstring
pack registry server or helm repo
tagstring
pack tag
typestring
Possible values: [spectro, helm, manifest]
type of the pack
valuesstring
values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values
versionstring
pack version
]
scopestring
scope or context(system, tenant or project)
typestring
Cluster profile type [ "cluster", "infra", "add-on", "system" ]
uidstring
Cluster profile uid
versionint32
labelsstring[]
labels for this pool, example: master/worker, gpu, windows
maintenanceModeint32
number of machines under maintenance
sizeint32
size of the pool, number of machines
]
uidstring
Cluster's cloud config uid
cloudaccount object
Cloud account meta information
namestring
uidstring
clusterProfileTemplate object
Cluster profile template meta information
cloudTypestring
Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]
Default value: all
namestring
Cluster profile name
packs object[]
Cluster profile packs array
Array [
annotations object
Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml
property name*string
digeststring
digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade
inValidReasonstring
isInvalidboolean
pack is invalid when the associated tag is deleted from the registry
layerstringrequired
Possible values: [kernel, os, k8s, cni, csi, addon]
manifests object[]
Array [
kindstring
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
namestring
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
uidstring
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
]
namestringrequired
pack name
packUidstring
PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.
params object
params passed as env variables to be consumed at installation time
property name*string
presets object[]
Array [
addstring
displayNamestring
groupstring
namestring
removestring[]
]
registryUidstring
pack registry uid
schema object[]
Array [
formatstring
hintsstring[]
listOptionsstring[]
namestring
readonlyboolean
regexstring
requiredboolean
typestring
]
serverstring
pack registry server or helm repo
tagstring
pack tag
typestring
Possible values: [spectro, helm, manifest]
type of the pack
valuesstring
values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values
versionstring
pack version
]
scopestring
scope or context(system, tenant or project)
typestring
Cluster profile type [ "cluster", "infra", "add-on", "system" ]
uidstring
Cluster profile uid
versionint32
clusterProfileTemplates object[]
Array [
cloudTypestring
Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]
Default value: all
namestring
Cluster profile name
packs object[]
Cluster profile packs array
Array [
annotations object
Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml
property name*string
digeststring
digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade
inValidReasonstring
isInvalidboolean
pack is invalid when the associated tag is deleted from the registry
layerstringrequired
Possible values: [kernel, os, k8s, cni, csi, addon]
manifests object[]
Array [
kindstring
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
namestring
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
uidstring
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
]
namestringrequired
pack name
packUidstring
PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.
params object
params passed as env variables to be consumed at installation time
property name*string
presets object[]
Array [
addstring
displayNamestring
groupstring
namestring
removestring[]
]
registryUidstring
pack registry uid
schema object[]
Array [
formatstring
hintsstring[]
listOptionsstring[]
namestring
readonlyboolean
regexstring
requiredboolean
typestring
]
serverstring
pack registry server or helm repo
tagstring
pack tag
typestring
Possible values: [spectro, helm, manifest]
type of the pack
valuesstring
values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values
versionstring
pack version
]
scopestring
scope or context(system, tenant or project)
typestring
Cluster profile type [ "cluster", "infra", "add-on", "system" ]
uidstring
Cluster profile uid
versionint32
]
status
Spectro cluster status summary
abortTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
addOnServices undefined[]
Array [
endpointstring
namestring
]
apiEndpoints object[]
Array [
hoststringrequired
The hostname on which the API server is serving.
portint32required
The port on which the API server is serving.
]
clusterImport object
importLinkstring
import link to download and install ally-lite, palette-lite
isBrownfieldboolean
Deprecated. Use the 'spec.clusterType'
statestring
cluster import status
conditions object[]
Array [
lastProbeTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
lastTransitionTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
messagestring
Human-readable message indicating details about last transition.
reasonstring
Unique, one-word, CamelCase reason for the condition's last transition.
statusstringrequired
typestringrequired
]
cost object
Resource Cost information
cloud object
Cloud cost information
computefloat64
storagefloat64
totalfloat64
totalfloat64
fips
modestring
Possible values: [full, none, partial, unknown]
Default value: none
health
Spectro cluster health status
agentVersionstring
conditions undefined[]
Array [
messagestring
relatedObject object
Object for which the resource is related
kindstring
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
namestring
uidstring
typestring
]
lastHeartBeatTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
statestring
hourlyRate object
Resource Cost information
cloud object
Cloud cost information
computefloat64
storagefloat64
totalfloat64
totalfloat64
kubeMeta object
Spectro cluster kube meta
hasKubeConfigboolean
hasKubeConfigClientboolean
hasManifestboolean
kubernetesVersionstring
location object
Cluster location information
coordinatesfloat64[]
countryCodestring
countryNamestring
regionCodestring
regionNamestring
metrics
Spectro cluster metrics
cpu object
Compute metrics
lastUpdatedTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
limitnumber
requestnumber
totalnumber
unitstring
usagenumber
memory object
Compute metrics
lastUpdatedTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
limitnumber
requestnumber
totalnumber
unitstring
usagenumber
notifications
Spectro cluster notifications
isAvailableboolean
packs object[]
Array [
condition object
lastProbeTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
lastTransitionTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
messagestring
Human-readable message indicating details about last transition.
reasonstring
Unique, one-word, CamelCase reason for the condition's last transition.
statusstringrequired
typestringrequired
endTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
manifests object[]
Array [
condition object
lastProbeTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
lastTransitionTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
messagestring
Human-readable message indicating details about last transition.
reasonstring
Unique, one-word, CamelCase reason for the condition's last transition.
statusstringrequired
typestringrequired
namestring
uidstring
]
namestring
profileUidstring
services object[]
Array [
hoststring
IP or Host from svc.Status.LoadBalancerStatus.Ingress
namestring
name of the loadbalancer service
ports object[]
port this service exposed
Array [
portint32required
The port that will be exposed by this service.
protocolstring
]
]
startTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
typestring
versionstring
]
services object[]
Array [
hoststring
IP or Host from svc.Status.LoadBalancerStatus.Ingress
namestring
name of the loadbalancer service
ports object[]
port this service exposed
Array [
portint32required
The port that will be exposed by this service.
protocolstring
]
]
spcApply object
actionTypestring
Possible values: [DownloadAndInstall, DownloadAndInstallLater]
canBeAppliedboolean
If it is true then Agent can apply the changes to the palette
lastModifiedTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
patchAppliedTimedate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
spcHashstring
statestring
current operational state
upgrades object[]
Array [
reasonstring[]
timestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
]
virtual
appDeployments object[]
list of apps deployed on the virtual cluster
Array [
kindstring
namestring
projectUidstring
tenantUidstring
uidstring
]
clusterGroup object
Object resource reference
kindstring
namestring
projectUidstring
tenantUidstring
uidstring
hostCluster object
Object resource reference
kindstring
namestring
projectUidstring
tenantUidstring
uidstring
lifecycleStatus
cluster life cycle status of virtual cluster
msgstring
error or success msg of lifecycle
statusstring
Possible values: [Pausing, Paused, Resuming, Running, Error]
lifecycle status
statestring
cluster virtual host status
virtualClusters object[]
list of virtual clusters deployed on the cluster
Array [
kindstring
namestring
projectUidstring
tenantUidstring
uidstring
]
workspaces object[]
Array [
kindstring
namestring
uidstringrequired
]

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2023-12-01T21:31:48.572Z",
    "deletionTimestamp": "2023-12-01T21:31:48.572Z",
    "labels": {},
    "lastModifiedTimestamp": "2023-12-01T21:31:48.572Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "archTypes": [
      "amd64"
    ],
    "cloudConfig": {
      "cloudType": "all",
      "machinePools": [
        {
          "cloudType": "all",
          "healthy": 0,
          "infraProfileTemplate": {
            "cloudType": "all",
            "name": "string",
            "packs": [
              {
                "annotations": {},
                "digest": "string",
                "inValidReason": "string",
                "isInvalid": true,
                "layer": "kernel",
                "manifests": [
                  {
                    "kind": "string",
                    "name": "string",
                    "uid": "string"
                  }
                ],
                "name": "string",
                "packUid": "string",
                "params": {},
                "presets": [
                  {
                    "add": "string",
                    "displayName": "string",
                    "group": "string",
                    "name": "string",
                    "remove": [
                      "string"
                    ]
                  }
                ],
                "registryUid": "string",
                "schema": [
                  {
                    "format": "string",
                    "hints": [
                      "string"
                    ],
                    "listOptions": [
                      "string"
                    ],
                    "name": "string",
                    "readonly": true,
                    "regex": "string",
                    "required": true,
                    "type": "string"
                  }
                ],
                "server": "string",
                "tag": "string",
                "type": "spectro",
                "values": "string",
                "version": "string"
              }
            ],
            "scope": "string",
            "type": "string",
            "uid": "string",
            "version": 0
          },
          "labels": [
            "string"
          ],
          "maintenanceMode": 0,
          "size": 0
        }
      ],
      "uid": "string"
    },
    "cloudaccount": {
      "name": "string",
      "uid": "string"
    },
    "clusterProfileTemplate": {
      "cloudType": "all",
      "name": "string",
      "packs": [
        {
          "annotations": {},
          "digest": "string",
          "inValidReason": "string",
          "isInvalid": true,
          "layer": "kernel",
          "manifests": [
            {
              "kind": "string",
              "name": "string",
              "uid": "string"
            }
          ],
          "name": "string",
          "packUid": "string",
          "params": {},
          "presets": [
            {
              "add": "string",
              "displayName": "string",
              "group": "string",
              "name": "string",
              "remove": [
                "string"
              ]
            }
          ],
          "registryUid": "string",
          "schema": [
            {
              "format": "string",
              "hints": [
                "string"
              ],
              "listOptions": [
                "string"
              ],
              "name": "string",
              "readonly": true,
              "regex": "string",
              "required": true,
              "type": "string"
            }
          ],
          "server": "string",
          "tag": "string",
          "type": "spectro",
          "values": "string",
          "version": "string"
        }
      ],
      "scope": "string",
      "type": "string",
      "uid": "string",
      "version": 0
    },
    "clusterProfileTemplates": [
      {
        "cloudType": "all",
        "name": "string",
        "packs": [
          {
            "annotations": {},
            "digest": "string",
            "inValidReason": "string",
            "isInvalid": true,
            "layer": "kernel",
            "manifests": [
              {
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "packUid": "string",
            "params": {},
            "presets": [
              {
                "add": "string",
                "displayName": "string",
                "group": "string",
                "name": "string",
                "remove": [
                  "string"
                ]
              }
            ],
            "registryUid": "string",
            "schema": [
              {
                "format": "string",
                "hints": [
                  "string"
                ],
                "listOptions": [
                  "string"
                ],
                "name": "string",
                "readonly": true,
                "regex": "string",
                "required": true,
                "type": "string"
              }
            ],
            "server": "string",
            "tag": "string",
            "type": "spectro",
            "values": "string",
            "version": "string"
          }
        ],
        "scope": "string",
        "type": "string",
        "uid": "string",
        "version": 0
      }
    ]
  },
  "status": {
    "abortTimestamp": "2023-12-01T21:31:48.573Z",
    "addOnServices": [
      {
        "endpoint": "string",
        "name": "string"
      }
    ],
    "apiEndpoints": [
      {
        "host": "string",
        "port": 0
      }
    ],
    "clusterImport": {
      "importLink": "string",
      "isBrownfield": true,
      "state": "string"
    },
    "conditions": [
      {
        "lastProbeTime": "2023-12-01T21:31:48.573Z",
        "lastTransitionTime": "2023-12-01T21:31:48.573Z",
        "message": "string",
        "reason": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "cost": {
      "cloud": {
        "compute": 0,
        "storage": 0,
        "total": 0
      },
      "total": 0
    },
    "fips": {
      "mode": "none"
    },
    "health": {
      "agentVersion": "string",
      "conditions": [
        {
          "message": "string",
          "relatedObject": {
            "kind": "spectrocluster",
            "name": "string",
            "uid": "string"
          },
          "type": "string"
        }
      ],
      "lastHeartBeatTimestamp": "2023-12-01T21:31:48.573Z",
      "state": "string"
    },
    "hourlyRate": {
      "cloud": {
        "compute": 0,
        "storage": 0,
        "total": 0
      },
      "total": 0
    },
    "kubeMeta": {
      "hasKubeConfig": true,
      "hasKubeConfigClient": true,
      "hasManifest": true,
      "kubernetesVersion": "string"
    },
    "location": {
      "coordinates": [
        0
      ],
      "countryCode": "string",
      "countryName": "string",
      "regionCode": "string",
      "regionName": "string"
    },
    "metrics": {
      "cpu": {
        "lastUpdatedTime": "2023-12-01T21:31:48.573Z",
        "limit": 0,
        "request": 0,
        "total": 0,
        "unit": "string",
        "usage": 0
      },
      "memory": {
        "lastUpdatedTime": "2023-12-01T21:31:48.573Z",
        "limit": 0,
        "request": 0,
        "total": 0,
        "unit": "string",
        "usage": 0
      }
    },
    "notifications": {
      "isAvailable": true
    },
    "packs": [
      {
        "condition": {
          "lastProbeTime": "2023-12-01T21:31:48.573Z",
          "lastTransitionTime": "2023-12-01T21:31:48.573Z",
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        },
        "endTime": "2023-12-01T21:31:48.573Z",
        "manifests": [
          {
            "condition": {
              "lastProbeTime": "2023-12-01T21:31:48.573Z",
              "lastTransitionTime": "2023-12-01T21:31:48.573Z",
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            },
            "name": "string",
            "uid": "string"
          }
        ],
        "name": "string",
        "profileUid": "string",
        "services": [
          {
            "host": "string",
            "name": "string",
            "ports": [
              {
                "port": 0,
                "protocol": "string"
              }
            ]
          }
        ],
        "startTime": "2023-12-01T21:31:48.573Z",
        "type": "string",
        "version": "string"
      }
    ],
    "services": [
      {
        "host": "string",
        "name": "string",
        "ports": [
          {
            "port": 0,
            "protocol": "string"
          }
        ]
      }
    ],
    "spcApply": {
      "actionType": "DownloadAndInstall",
      "canBeApplied": true,
      "lastModifiedTime": "2023-12-01T21:31:48.573Z",
      "patchAppliedTime": "2023-12-01T21:31:48.573Z",
      "spcHash": "string"
    },
    "state": "string",
    "upgrades": [
      {
        "reason": [
          "string"
        ],
        "timestamp": "2023-12-01T21:31:48.573Z"
      }
    ],
    "virtual": {
      "appDeployments": [
        {
          "kind": "string",
          "name": "string",
          "projectUid": "string",
          "tenantUid": "string",
          "uid": "string"
        }
      ],
      "clusterGroup": {
        "kind": "string",
        "name": "string",
        "projectUid": "string",
        "tenantUid": "string",
        "uid": "string"
      },
      "hostCluster": {
        "kind": "string",
        "name": "string",
        "projectUid": "string",
        "tenantUid": "string",
        "uid": "string"
      },
      "lifecycleStatus": {
        "msg": "string",
        "status": "Pausing"
      },
      "state": "string",
      "virtualClusters": [
        {
          "kind": "string",
          "name": "string",
          "projectUid": "string",
          "tenantUid": "string",
          "uid": "string"
        }
      ]
    },
    "workspaces": [
      {
        "kind": "string",
        "name": "string",
        "uid": "string"
      }
    ]
  }
}

Loading...