Validates if cluster gets repaved for the specified packs

POST 
/v1/spectroclusters/:uid/validate/repave

Validates if cluster gets repaved for the specified packs

Request

Path Parameters

uid stringrequired

cluster uid

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

profiles

object[]

Array [

packValues

object[]

Cluster profile packs array

Array [

manifests

undefined[]

Pack manifests are additional content as part of the profile

Array [

contentstring

Manifest content in yaml

namestringrequired

Manifest name

uidstring

Manifest uid

]

namestringrequired

Pack name

tagstring

Pack version tag

typestring

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

Default value: spectro

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

]

replaceWithProfilestring

Cluster profile uid to be replaced with new profile

uidstring

Cluster profile uid

variables

object[]

Array [

namestringrequired

Variable name

valuestring

Actual value of the variable to be used within the cluster

]

]

Responses

200

Cluster repave validation response

application/json

Schema

Schema

isRepaveRequiredboolean

If true then the pack changes can cause cluster repave

reasons

object[]

Array [

codestring

messagestring

pack

object

Cluster pack difference

current

object

PackRef server/name:tag to point to a pack PackRef is used when construct a ClusterProfile PackSpec is used for UI to render the parameters form ClusterProfile will not know inner details of a pack ClusterProfile only contain pack name:tag, and the param values user entered for it

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

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

diffConfigKeysstring[]

target

object

PackRef server/name:tag to point to a pack PackRef is used when construct a ClusterProfile PackSpec is used for UI to render the parameters form ClusterProfile will not know inner details of a pack ClusterProfile only contain pack name:tag, and the param values user entered for it

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

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

]

Example (from schema)

{
  "isRepaveRequired": true,
  "reasons": [
    {
      "code": "string",
      "message": "string",
      "pack": {
        "current": {
          "annotations": {},
          "digest": "string",
          "inValidReason": "string",
          "isInvalid": true,
          "layer": "kernel",
          "logo": "string",
          "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"
        },
        "diffConfigKeys": [
          "string"
        ],
        "target": {
          "annotations": {},
          "digest": "string",
          "inValidReason": "string",
          "isInvalid": true,
          "layer": "kernel",
          "logo": "string",
          "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"
        }
      }
    }
  ]
}

Loading...