Returns the associated profiles of a specified cluster group

GET 
/v1/clustergroups/:uid/profiles

Returns the associated profiles of a specified cluster group

Request

Path Parameters

uid stringrequired

ClusterGroup uid

Query Parameters

includePackMeta string

includes pack meta such as schema, presets

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

OK

application/json

Schema

Schema

profiles

object[]

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

object

Cluster profile spec response

cloudTypestring

Cluster profile cloud type

packs

object[]

Cluster profile packs array

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

object

Pack object

addonSubTypestring

Pack add-on sub type such as monitoring, db etc

addonTypestring

Pack add-on type such as logging, monitoring, security etc

annotations

object

Pack annotations is used to allow pack to add more arbitrary configurations

property name*string

cloudTypesstring[]

Pack supported cloud types

digeststring

Pack digest

displayNamestring

Pack display name

eolstring

Pack end of life, date format: yyyy-MM-dd

groupstring

Pack group

layerstring

Possible values: [kernel, os, k8s, cni, csi, addon]

logoUrlstring

Pack logo url

manifests

object[]

Pack manifests are additional content as part of the cluster profile

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.

]

namestring

Pack name

presets

object[]

Pack presets are the set of configurations applied on user selection of presets

Array [

addstring

displayNamestring

groupstring

namestring

removestring[]

]

registryUidstring

Pack registry uid

schema

object[]

Pack schema contains constraints such as data type, format, hints for the pack values

Array [

formatstring

hintsstring[]

listOptionsstring[]

namestring

readonlyboolean

regexstring

requiredboolean

typestring

]

template

Pack template configuration

manifeststring

Pack template manifest content

parameters

Pack template parameters

inputParameters

undefined[]

Pack template input parameters array

Array [

descriptionstring

Pack template parameter description

displayNamestring

Pack template parameter display name

formatstring

Pack template parameter format

hiddenboolean

Pack template parameter hidden flag, if true then the parameter is hidden in the UI

listOptionsstring[]

Pack template parameter list options as string array

namestring

Pack template parameter name

optionalboolean

Pack template parameter optional flag, if true then the parameter value is not mandatory

options

object

Pack template parameter options array

property name*

object

Pack template parameter option

dependencies

object[]

Pack template parameter dependencies

Array [

layerstring

Pack template dependency pack layer

namestring

Pack template dependency pack name

readOnlyboolean

If true then dependency pack values can't be overridden

]

descriptionstring

Pack template parameter description

labelstring

Pack template parameter label

readOnlyboolean

Pack template parameter readonly flag, if true then the parameter value can't be overridden

regexstring

Pack template parameter regex, if set then parameter value must match with specified regex

targetKeystring

Pack template parameter target key which is mapped to the key defined in the pack values

typestring

Pack template parameter data type

valuestring

Pack template parameter value

]

outputParameters

undefined[]

Pack template output parameters array

Array [

descriptionstring

Pack template parameter description

displayNamestring

Pack template parameter display name

formatstring

Pack template parameter format

hiddenboolean

Pack template parameter hidden flag, if true then the parameter is hidden in the UI

listOptionsstring[]

Pack template parameter list options as string array

namestring

Pack template parameter name

optionalboolean

Pack template parameter optional flag, if true then the parameter value is not mandatory

options

object

Pack template parameter options array

property name*

object

Pack template parameter option

dependencies

object[]

Pack template parameter dependencies

Array [

layerstring

Pack template dependency pack layer

namestring

Pack template dependency pack name

readOnlyboolean

If true then dependency pack values can't be overridden

]

descriptionstring

Pack template parameter description

labelstring

Pack template parameter label

readOnlyboolean

Pack template parameter readonly flag, if true then the parameter value can't be overridden

regexstring

Pack template parameter regex, if set then parameter value must match with specified regex

targetKeystring

Pack template parameter target key which is mapped to the key defined in the pack values

typestring

Pack template parameter data type

valuestring

Pack template parameter value

]

valuesstring

Pack template values

typestring

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

Default value: spectro

valuesstring

Pack values

versionstring

Pack version

statusobject

Pack status

]

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.

uidstring

UID of the referent.

typestring

Cluster profile type [ "cluster", "infra", "add-on", "system" ]

versionint32

Cluster profile version

]

Example (from schema)

{
  "profiles": [
    {
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-04-16T17:49:00.641Z",
        "deletionTimestamp": "2024-04-16T17:49:00.641Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-04-16T17:49:00.641Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "cloudType": "string",
        "packs": [
          {
            "metadata": {
              "annotations": {},
              "creationTimestamp": "2024-04-16T17:49:00.641Z",
              "deletionTimestamp": "2024-04-16T17:49:00.641Z",
              "labels": {},
              "lastModifiedTimestamp": "2024-04-16T17:49:00.641Z",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "addonSubType": "string",
              "addonType": "string",
              "annotations": {},
              "cloudTypes": [
                "string"
              ],
              "digest": "string",
              "displayName": "string",
              "eol": "string",
              "group": "string",
              "layer": "kernel",
              "logoUrl": "string",
              "manifests": [
                {
                  "kind": "string",
                  "name": "string",
                  "uid": "string"
                }
              ],
              "name": "string",
              "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"
                }
              ],
              "template": {
                "manifest": "string",
                "parameters": {
                  "inputParameters": [
                    {
                      "description": "string",
                      "displayName": "string",
                      "format": "string",
                      "hidden": true,
                      "listOptions": [
                        "string"
                      ],
                      "name": "string",
                      "optional": true,
                      "options": {},
                      "readOnly": true,
                      "regex": "string",
                      "targetKey": "string",
                      "type": "string",
                      "value": "string"
                    }
                  ],
                  "outputParameters": [
                    {
                      "description": "string",
                      "displayName": "string",
                      "format": "string",
                      "hidden": true,
                      "listOptions": [
                        "string"
                      ],
                      "name": "string",
                      "optional": true,
                      "options": {},
                      "readOnly": true,
                      "regex": "string",
                      "targetKey": "string",
                      "type": "string",
                      "value": "string"
                    }
                  ]
                },
                "values": "string"
              },
              "type": "spectro",
              "values": "string",
              "version": "string"
            },
            "status": {}
          }
        ],
        "relatedObject": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        },
        "type": "string",
        "version": 0
      }
    }
  ]
}

Loading...