Retrieves a list of cluster profiles

GET 
/v1/clusterprofiles

Deprecated: Use POST /v1/dashboard/clusterprofiles

Request

Query Parameters

fields string

Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name

filters string

Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws

Server will be restricted to certain fields based on the indexed data for each resource.

orderBy string

Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1

limit int64

Default value: 50

limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.

offset int64

offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.

continue string

continue token to paginate the subsequent data items

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

An array of cluster profile items

application/json

Schema

Schema

items object[]required
Array [
kindstring
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
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 object
ClusterProfileTemplate can be in draft mode, or published mode User only see the latest published template, and (or) the draft template User can apply either the draft version or the latest published version to a cluster when user create a draft version, just copy the Published template, increment the version, and keep changing the draft template without increment the draft version when user publish a draft, the version is fixed, and won't be able to make any modification on published template For each clusterprofile that has a published version, there will be a ClusterProfileArchive automatically created when user publish a draft, the published version will also be copied over to the corresponding ClusterProfileArchive it is just in case in the future for whatever reason we may want to expose earlier versions
draft object
ClusterProfileTemplate contains details of a clusterprofile definition
cloudTypestring
Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]
Default value: all
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]
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
published object
ClusterProfileTemplate contains details of a clusterprofile definition
cloudTypestring
Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]
Default value: all
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]
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
versionstring
versions undefined[]
Cluster profile's list of all the versions
Array [
uidstring
versionstring
]
status object
ClusterProfileStatus defines the observed state of ClusterProfile
hasUserMacrosboolean
If it is true then profile pack values has a reference to user defined macros
inUseClusterUidsstring[]
Deprecated. Use inUseClusters
inUseClusters object[]
Array [
kindstring
namestring
projectUidstring
tenantUidstring
uidstring
]
isPublishedboolean
]
listmeta object

ListMeta describes metadata for the resource listing

continuestring

Next token for the pagination. Next token is equal to empty string indicates end of result set.

countinteger

Total count of the resources which might change during pagination based on the resources addition or deletion

limitinteger

Number of records feteched

offsetinteger

The next offset for the pagination. Starting index for which next request will be placed.

Example (from schema)

{
  "items": [
    {
      "kind": "string",
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2023-12-01T21:31:48.456Z",
        "deletionTimestamp": "2023-12-01T21:31:48.456Z",
        "labels": {},
        "lastModifiedTimestamp": "2023-12-01T21:31:48.456Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "draft": {
          "cloudType": "all",
          "name": "string",
          "packServerRefs": [
            {
              "kind": "string",
              "name": "string",
              "uid": "string"
            }
          ],
          "packServerSecret": "string",
          "packs": [
            {
              "annotations": {},
              "digest": "string",
              "inValidReason": "string",
              "isInvalid": true,
              "layer": "kernel",
              "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
        },
        "published": {
          "cloudType": "all",
          "name": "string",
          "packServerRefs": [
            {
              "kind": "string",
              "name": "string",
              "uid": "string"
            }
          ],
          "packServerSecret": "string",
          "packs": [
            {
              "annotations": {},
              "digest": "string",
              "inValidReason": "string",
              "isInvalid": true,
              "layer": "kernel",
              "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
        },
        "version": "string",
        "versions": [
          {
            "uid": "string",
            "version": "string"
          }
        ]
      },
      "status": {
        "hasUserMacros": true,
        "inUseClusterUids": [
          "string"
        ],
        "inUseClusters": [
          {
            "kind": "string",
            "name": "string",
            "projectUid": "string",
            "tenantUid": "string",
            "uid": "string"
          }
        ],
        "isPublished": true
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

Loading...