Returns the specified cluster summary overview
GET/v1/dashboard/spectroclusters/:uid/overview
Returns the specified cluster summary overview
Request
Path Parameters
Header Parameters
Scope the request to the specified project uid
Responses
- 200
An spectro cluster summary overview
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
Array [
]
Array [
]
]
]
Array [
Array [
]
Array [
]
Array [
]
]
Array [
Array [
Array [
]
Array [
]
Array [
]
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
Array [
Array [
]
]
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
metadata
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations
object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
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.
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
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
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.
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
spec
object
Spectro cluster spec summary
Possible values: [amd64, arm64]
Architecture types of the cluster
cloudConfig
object
machinePools
object[]
Machine pool meta information
number of healthy machines
infraProfileTemplate
object
InfraClusterProfile contains OS/Kernel for this NodePool
Cluster profile name
packs
object[]
Cluster profile packs array
annotations
object
Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml
digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade
pack is invalid when the associated tag is deleted from the registry
Possible values: [kernel, os, k8s, cni, csi, addon]
path to the pack logo
manifests
object[]
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
pack name
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
presets
object[]
pack registry uid
schema
object[]
pack registry server or helm repo
pack tag
Possible values: [spectro, helm, manifest]
type of the pack
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
pack version
scope or context(system, tenant or project)
Cluster profile type [ "cluster", "infra", "add-on", "system" ]
Cluster profile uid
whether this pool is for control plane
labels for this pool, example: control-plane/worker, gpu, windows
number of machines under maintenance
size of the pool, number of machines
Cluster's cloud config uid
cloudaccount
object
Cloud account meta information
clusterProfileTemplate
object
Cluster profile template meta information
Cluster profile name
packs
object[]
Cluster profile packs array
annotations
object
Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml
digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade
pack is invalid when the associated tag is deleted from the registry
Possible values: [kernel, os, k8s, cni, csi, addon]
path to the pack logo
manifests
object[]
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
pack name
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
presets
object[]
pack registry uid
schema
object[]
pack registry server or helm repo
pack tag
Possible values: [spectro, helm, manifest]
type of the pack
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
pack version
scope or context(system, tenant or project)
Cluster profile type [ "cluster", "infra", "add-on", "system" ]
Cluster profile uid
clusterProfileTemplates
object[]
Cluster profile name
packs
object[]
Cluster profile packs array
annotations
object
Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml
digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade
pack is invalid when the associated tag is deleted from the registry
Possible values: [kernel, os, k8s, cni, csi, addon]
path to the pack logo
manifests
object[]
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
pack name
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
presets
object[]
pack registry uid
schema
object[]
pack registry server or helm repo
pack tag
Possible values: [spectro, helm, manifest]
type of the pack
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
pack version
scope or context(system, tenant or project)
Cluster profile type [ "cluster", "infra", "add-on", "system" ]
Cluster profile uid
status
Spectro cluster status summary
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[]
apiEndpoints
object[]
The hostname on which the API server is serving.
The port on which the API server is serving.
clusterImport
object
import link to download and install ally-lite, palette-lite
Deprecated. Use the 'spec.clusterType'
cluster import status
conditions
object[]
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.
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.
Human-readable message indicating details about last transition.
Unique, one-word, CamelCase reason for the condition's last transition.
cost
object
Resource Cost information
cloud
object
Cloud cost information
fips
Possible values: [full, none, partial, unknown]
Default value: none
health
Spectro cluster health status
conditions
undefined[]
relatedObject
object
Object for which the resource is related
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
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.
hourlyRate
object
Resource Cost information
cloud
object
Cloud cost information
kubeMeta
object
Spectro cluster kube meta
location
object
Cluster location information
metrics
Spectro cluster metrics
cpu
object
Compute metrics
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.
memory
object
Compute metrics
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.
notifications
Cluster notifications status
packs
object[]
condition
object
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.
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.
Human-readable message indicating details about last transition.
Unique, one-word, CamelCase reason for the condition's last transition.
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[]
condition
object
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.
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.
Human-readable message indicating details about last transition.
Unique, one-word, CamelCase reason for the condition's last transition.
services
object[]
IP or Host from svc.Status.LoadBalancerStatus.Ingress
name of the loadbalancer service
ports
object[]
port this service exposed
The port that will be exposed by this service.
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.
services
object[]
IP or Host from svc.Status.LoadBalancerStatus.Ingress
name of the loadbalancer service
ports
object[]
port this service exposed
The port that will be exposed by this service.
spcApply
object
Possible values: [DownloadAndInstall, DownloadAndInstallLater]
If it is true then Agent can apply the changes to the palette
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.
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.
current operational state
upgrades
object[]
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
clusterGroup
object
Object resource reference
hostCluster
object
Object resource reference
lifecycleStatus
cluster life cycle status of virtual cluster
error or success msg of lifecycle
Possible values: [Pausing, Paused, Resuming, Running, Error]
lifecycle status
cluster virtual host status
virtualClusters
object[]
list of virtual clusters deployed on the cluster
workspaces
object[]
{
"metadata": {
"annotations": {},
"creationTimestamp": "2024-07-03T13:23:53.146Z",
"deletionTimestamp": "2024-07-03T13:23:53.146Z",
"labels": {},
"lastModifiedTimestamp": "2024-07-03T13:23:53.146Z",
"name": "string",
"uid": "string"
},
"spec": {
"archTypes": [
"amd64"
],
"cloudConfig": {
"cloudType": "string",
"machinePools": [
{
"cloudType": "string",
"healthy": 0,
"infraProfileTemplate": {
"cloudType": "string",
"name": "string",
"packs": [
{
"annotations": {},
"digest": "string",
"inValidReason": "string",
"isInvalid": true,
"layer": "kernel",
"logo": "string",
"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
},
"isControlPlane": true,
"labels": [
"string"
],
"maintenanceMode": 0,
"size": 0
}
],
"uid": "string"
},
"cloudaccount": {
"name": "string",
"uid": "string"
},
"clusterProfileTemplate": {
"cloudType": "string",
"name": "string",
"packs": [
{
"annotations": {},
"digest": "string",
"inValidReason": "string",
"isInvalid": true,
"layer": "kernel",
"logo": "string",
"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": "string",
"name": "string",
"packs": [
{
"annotations": {},
"digest": "string",
"inValidReason": "string",
"isInvalid": true,
"layer": "kernel",
"logo": "string",
"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": "2024-07-03T13:23:53.147Z",
"addOnServices": [
{
"endpoint": "string",
"name": "string"
}
],
"apiEndpoints": [
{
"host": "string",
"port": 0
}
],
"clusterImport": {
"importLink": "string",
"isBrownfield": true,
"state": "string"
},
"conditions": [
{
"lastProbeTime": "2024-07-03T13:23:53.147Z",
"lastTransitionTime": "2024-07-03T13:23:53.147Z",
"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": "2024-07-03T13:23:53.147Z",
"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": "2024-07-03T13:23:53.147Z",
"limit": 0,
"request": 0,
"total": 0,
"unit": "string",
"usage": 0
},
"memory": {
"lastUpdatedTime": "2024-07-03T13:23:53.147Z",
"limit": 0,
"request": 0,
"total": 0,
"unit": "string",
"usage": 0
}
},
"notifications": {
"isAvailable": true
},
"packs": [
{
"condition": {
"lastProbeTime": "2024-07-03T13:23:53.148Z",
"lastTransitionTime": "2024-07-03T13:23:53.148Z",
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
},
"endTime": "2024-07-03T13:23:53.148Z",
"manifests": [
{
"condition": {
"lastProbeTime": "2024-07-03T13:23:53.148Z",
"lastTransitionTime": "2024-07-03T13:23:53.148Z",
"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": "2024-07-03T13:23:53.148Z",
"type": "string",
"version": "string"
}
],
"services": [
{
"host": "string",
"name": "string",
"ports": [
{
"port": 0,
"protocol": "string"
}
]
}
],
"spcApply": {
"actionType": "DownloadAndInstall",
"canBeApplied": true,
"crdDigest": "string",
"lastModifiedTime": "2024-07-03T13:23:53.148Z",
"patchAppliedTime": "2024-07-03T13:23:53.148Z",
"spcHash": "string",
"spcInfraHash": "string"
},
"state": "string",
"upgrades": [
{
"reason": [
"string"
],
"timestamp": "2024-07-03T13:23:53.148Z"
}
],
"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"
}
]
}
}