Skip to main content

Create cluster groups

POST 
/v1/clustergroups

Create cluster groups

Request​

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    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

    Cluster group specifications request entity

    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
    profiles object[]
  • Array [
    • packValues object[]

    Cluster profile packs array

  • Array [
    • manifests undefined[]

    Pack manifests are additional content as part of the profile

  • Array [
    • contentstring

    Manifest content in yaml

    namestringrequired

    Manifest name

    uidstring

    Manifest uid

  • ]
    • namestringrequired

    Pack name

    tagstring

    Pack version tag

    typestring

    Possible values: [spectro, helm, manifest, oci]

    Default value: spectro

    valuesstring

    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

  • ]
    • replaceWithProfilestring

    Cluster profile uid to be replaced with new profile

    uidstring

    Cluster profile uid

  • ]
    • typestring

    Possible values: [hostCluster]

Responses​

Created successfully

Response Headers
  • AuditUid string

    Audit uid for the request

Schema
    uidstringrequired
Loading...