Skip to main content
Version: latest

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

OK

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

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

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

  • ]

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

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

    versionint32

    Cluster profile version

  • ]

Loading...