Skip to main content
Version: latest

Creates a cluster profile

POST 
/v1/clusterprofiles

Creates a cluster profile

Request​

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    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

    template

    object

    Cluster profile template spec

    cloudTypestring

    packs

    object[]

    Cluster profile packs array

  • Array [

    • layerstring

    Pack layer

    manifests

    undefined[]

    Pack manifests are additional content as part of the profile

  • Array [

    • contentstring

    Manifest content

    namestring

    Manifest name

  • ]

    • namestringrequired

    Pack name

    registryUidstring

    Pack registry uid

    tagstring

    Pack tag

    typestring

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

    Default value: spectro

    uidstring

    Pack uid

    valuesstring

    Pack 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

  • ]

    • typestring

    Possible values: [cluster, infra, add-on, system]

    Default value: cluster

    variables

    object[]

    List of unique variable fields defined for a cluster profile with schema constraints

  • Array [

    • defaultValuestring

    The default value of the variable

    descriptionstring

    Variable description

    displayNamestring

    Unique display name of the variable

    formatstring

    Possible values: [string, number, boolean, ipv4, ipv4cidr, ipv6, version]

    Default value: string

    Format type of the variable value

    hiddenboolean

    If true, then variable will be hidden for overriding the value. By default the hidden flag will be set to false

    immutableboolean

    If true, then variable value can't be editable. By default the immutable flag will be set to false

    isSensitiveboolean

    If true, then default value will be masked. By default the isSensitive flag will be set to false

    namestringrequired

    Variable name

    regexstring

    Regular expression pattern which the variable value must match

    requiredboolean

    Flag to specify if the variable is optional or mandatory. If it is mandatory then default value must be provided

  • ]

    • versionstring

    Cluster profile version

Responses​

Created successfully

Response Headers

  • AuditUid

    string

    Audit uid for the request

Schema

    uidstringrequired
Loading...