Retrieves a list of cluster groups host cluster summary

GET 
/v1/clustergroups/hostCluster

Retrieves a list of cluster groups host cluster summary

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

An array of cluster groups of host cluster type summary

application/json

Schema

Schema

summaries

undefined[]

required

Array [

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

Cluster group summay spec

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

]

cpu

Cluster group resource allocated and usage information

allocatedfloat64

usedfloat64

endpointTypestring

Possible values: [Ingress, LoadBalancer]

hostClusters

object[]

Array [

kindstring

namestring

projectUidstring

tenantUidstring

uidstring

]

hostClustersCountinteger

memory

Cluster group resource allocated and usage information

allocatedfloat64

usedfloat64

scopestring

virtualClustersCountinteger

]

Example (from schema)

{
  "summaries": [
    {
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-05-04T15:42:52.631Z",
        "deletionTimestamp": "2024-05-04T15:42:52.631Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-05-04T15:42:52.631Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "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
          }
        ],
        "cpu": {
          "allocated": 0,
          "used": 0
        },
        "endpointType": "Ingress",
        "hostClusters": [
          {
            "kind": "string",
            "name": "string",
            "projectUid": "string",
            "tenantUid": "string",
            "uid": "string"
          }
        ],
        "hostClustersCount": 0,
        "memory": {
          "allocated": 0,
          "used": 0
        },
        "scope": "string",
        "virtualClustersCount": 0
      }
    }
  ]
}

Loading...