Returns the associated profile's pack manifests of a specified cluster

GET 
/v1/spectroclusters/:uid/profiles/packs/manifests

Returns the associated profile's pack manifests of a specified cluster

Request

Path Parameters

uid stringrequired

Cluster uid

Query Parameters

includePackMeta string

Includes pack meta such as schema, presets

resolveMacros boolean

Resolve pack macro variables if set to true

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

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

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

undefined[]

Pack manifests are additional content as part of the cluster profile

Array [

contentstring

Manifest content in yaml

namestring

Manifest name

uidstring

Manifest uid

]

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

]

typestring

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

Default value: spectro

valuesstring

Pack values

versionstring

Pack version

statusobject

Pack status

]

]

Example (from schema)

{
  "profiles": [
    {
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-04-16T17:49:02.003Z",
        "deletionTimestamp": "2024-04-16T17:49:02.003Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-04-16T17:49:02.003Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "packs": [
          {
            "metadata": {
              "annotations": {},
              "creationTimestamp": "2024-04-16T17:49:02.004Z",
              "deletionTimestamp": "2024-04-16T17:49:02.004Z",
              "labels": {},
              "lastModifiedTimestamp": "2024-04-16T17:49:02.004Z",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "addonType": "string",
              "annotations": {},
              "cloudTypes": [
                "string"
              ],
              "digest": "string",
              "displayName": "string",
              "eol": "string",
              "group": "string",
              "layer": "kernel",
              "logoUrl": "string",
              "manifests": [
                {
                  "content": "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"
                }
              ],
              "type": "spectro",
              "values": "string",
              "version": "string"
            },
            "status": {}
          }
        ]
      }
    }
  ]
}

Loading...