Skip to main content
Version: latest

Returns the specified OpenStack private gateway cluster profile

GET 

/v1/overlords/openstack/:uid/clusterprofile

Returns the specified OpenStack private gateway cluster profile

Request

Path Parameters

    uid stringrequired

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses

OK

Schema

    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, other than that any input on annotations will be ignored

    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 or Tags (UI) 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
    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

    Represents the resource kind

    namestring

    Name of the resource

    uidstring

    Uid of the resource

  • ]

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

    logostring

    path to the pack logo

    manifests

    object[]

  • Array [

  • kindstring

    Represents the resource kind

    namestring

    Name of the resource

    uidstring

    Uid of the resource

  • ]

  • 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

    Represents the resource kind

    namestring

    Name of the resource

    uidstring

    Uid of the resource

    typestring
    uidstring
    versionint32

    Deprecated. Use profileVersion

    published

    object

    ClusterProfileTemplate contains details of a clusterprofile definition

    cloudTypestring
    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

    Represents the resource kind

    namestring

    Name of the resource

    uidstring

    Uid of the resource

  • ]

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

    logostring

    path to the pack logo

    manifests

    object[]

  • Array [

  • kindstring

    Represents the resource kind

    namestring

    Name of the resource

    uidstring

    Uid of the resource

  • ]

  • 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

    Represents the resource kind

    namestring

    Name of the resource

    uidstring

    Uid of the resource

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