Returns the specified cluster groups

GET 
/v1/clustergroups/:uid

Returns the specified cluster groups

Request

Path Parameters

uid stringrequired

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

OK

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

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

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

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

uidstring

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

Cluster group specifications

clusterProfileTemplates

object[]

ClusterProfileTemplate is a copy of the draft version or latest published version of the clusterprofileSpec. It consists of list of add on profiles at a cluster group level which will be enforced on all virtual cluster. ClusterProfileTemplate will be updated from the clusterprofile pointed by ClusterProfileRef

Array [

cloudTypestring

namestring

packServerRefs

object[]

PackServerRefs is only used on Hubble side it is reference to pack registry servers which PackRef belongs to in hubble, pack server is a top level object, so use a reference to point to it packs within a clusterprofile can come from different pack servers, so this is an array

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

]

packServerSecretstring

This secret is used only on Palette side use case is similar to k8s image pull secret this single secret internally should contains all the pack servers in PackServerRefs if empty, means no credential is needed to access the pack server For spectro saas, Ally will set this field before pass to palette

packs

object[]

Packs definitions here are final definitions. If ClonedFrom and ParamsOverwrite is present, then Packs are the final merge result of ClonedFrom and ParamsOverwrite So orchestration engine will just take the Packs and do the work, no need to worry about parameters merge

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

]

profileVersionstring

version start from 1.0.0, matching the index of ClusterProfileSpec.Versions[] will be used by clusterSpec to identify which version is applied to the cluster

relatedObject

object

ObjectReference contains enough information to let you inspect or modify the referred object.

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

typestring

uidstring

versionint32

Deprecated. Use profileVersion

]

clusterRefs

undefined[]

Array [

clusterNamestring

clusterUidstring

]

clustersConfig

Clusters config of cluster group

endpointTypestring

Possible values: [Ingress, LoadBalancer]

Host cluster endpoint type

hostClustersConfig

undefined[]

Array [

clusterUidstring

endpointConfig

host cluster endpoint configuration

ingressConfig

Ingress configuration for exposing the virtual cluster's kube-apiserver

hoststring

portint64

loadBalancerConfig

Load balancer configuration for exposing the virtual cluster's kube-apiserver

externalIPsstring[]

externalTrafficPolicystring

loadBalancerSourceRangesstring[]

]

kubernetesDistroTypestring

Possible values: [k3s, cncf_k8s]

Default value: k3s

limitConfig

Cluster group limit config

cpuint32

Deprecated. Use field cpuMilliCore

cpuMilliCoreint32

CPU in milli cores

memoryint32

Deprecated. Use field memoryMiB

memoryMiBint32

Memory in MiB

overSubscriptionint32

Over subscription percentage

storageGiBint32

Storage in GiB

valuesstring

typestring

Possible values: [hostCluster]

status

Cluster group status

isActiveboolean

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T18:20:57.658Z",
    "deletionTimestamp": "2024-07-02T18:20:57.658Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T18:20:57.658Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "clusterProfileTemplates": [
      {
        "cloudType": "string",
        "name": "string",
        "packServerRefs": [
          {
            "kind": "string",
            "name": "string",
            "uid": "string"
          }
        ],
        "packServerSecret": "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"
          }
        ],
        "profileVersion": "string",
        "relatedObject": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        },
        "type": "string",
        "uid": "string",
        "version": 0
      }
    ],
    "clusterRefs": [
      {
        "clusterName": "string",
        "clusterUid": "string"
      }
    ],
    "clustersConfig": {
      "endpointType": "Ingress",
      "hostClustersConfig": [
        {
          "clusterUid": "string",
          "endpointConfig": {
            "ingressConfig": {
              "host": "string",
              "port": 0
            },
            "loadBalancerConfig": {
              "externalIPs": [
                "string"
              ],
              "externalTrafficPolicy": "string",
              "loadBalancerSourceRanges": [
                "string"
              ]
            }
          }
        }
      ],
      "kubernetesDistroType": "k3s",
      "limitConfig": {
        "cpu": 0,
        "cpuMilliCore": 0,
        "memory": 0,
        "memoryMiB": 0,
        "overSubscription": 0,
        "storageGiB": 0
      },
      "values": "string"
    },
    "type": "hostCluster"
  },
  "status": {
    "isActive": true
  }
}

Loading...