Skip to main content
Version: latest

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

An spectro cluster summary overview

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.

    spec

    object

    Spectro cluster spec summary

    archTypesstring[]

    Possible values: [amd64, arm64]

    Architecture types of the cluster

    cloudConfig

    object

    cloudTypestring

    machinePools

    object[]

    Machine pool meta information

  • Array [

  • cloudTypestring
    healthyint32

    number of healthy machines

    infraProfileTemplate

    object

    InfraClusterProfile contains OS/Kernel for this NodePool

    cloudTypestring
    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]

    logostring

    path to the pack logo

    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.

    uidstring

    UID of the referent.

  • ]

  • 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
    isControlPlaneboolean

    whether this pool is for control plane

    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
    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]

    logostring

    path to the pack logo

    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.

    uidstring

    UID of the referent.

  • ]

  • 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
    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]

    logostring

    path to the pack logo

    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.

    uidstring

    UID of the referent.

  • ]

  • 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

    crdDigeststring
    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
    spcInfraHashstring
    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
  • ]

Loading...