Validates Custom cluster create operation

POST 
https://api.spectrocloud.com/v1/spectroclusters/cloudTypes/:cloudType/validate

Validates Custom cluster create operation

Request

Path Parameters

cloudType stringrequired

Cluster's cloud type

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

metadata

object

ObjectMeta input entity for object creation

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

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

namestring

Name of the resource.

spec

object

cloudAccountUidstringrequired

Cloud account uid to be used for cluster provisioning

cloudConfig

object

required

Cluster level configuration for Custom cloud and applicable for all the machine pools

valuesstringrequired

YAML string for Cluster and CloudCluster

clusterConfig

object

General cluster configuration like patching settings, namespace resource allocation, rbac

location

object

Cluster location information

countryCodestring

country code for cluster location

countryNamestring

country name for cluster location

geoLoc

object

Geolocation Latlong entity

latitudefloat64

Latitude of a resource

longitudefloat64

Longitude of a resource

regionCodestring

region code for cluster location

regionNamestring

region name for cluster location

machineManagementConfig

object

osPatchConfig

object

Os patch config contains properties to patch node os with latest security packages. If OsPatchConfig is not provided then node os will not be patched with latest security updates.

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

patchOnBootboolean

PatchOnBoot indicates need to do patch when node first boot up, only once

rebootIfRequiredboolean

Reboot once the OS patch is applied

schedulestring

The schedule at which security patches will be applied to OS. Schedule should be in Cron format, see https://en.wikipedia.org/wiki/Cron for more help.

resources

object

namespaces

object[]

Array [

metadata

object

ObjectMeta update entity with uid as input

annotations

object

property name*string

labels

object

property name*string

namestring

uidstring

spec

Cluster namespace spec

isRegexboolean

relatedObject

object

Object for which the resource is related

kindstring

Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

namestring

uidstring

resourceAllocation

Cluster namespace resource allocation

cpuCoresnumber

memoryMiBnumber

]

rbacs

object[]

Array [

metadata

object

ObjectMeta update entity with uid as input

annotations

object

property name*string

labels

object

property name*string

namestring

uidstring

spec

object

Cluster RBAC spec

bindings

object[]

Array [

namespacestring

role

object

Cluster role ref

kindstring

Possible values: [Role, ClusterRole]

namestring

subjects

object[]

Array [

namestring

namespacestring

typestring

Possible values: [User, Group, ServiceAccount]

]

typestring

Possible values: [RoleBinding, ClusterRoleBinding]

]

relatedObject

object

Object for which the resource is related

kindstring

Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

namestring

uidstring

]

machinepoolconfig

object[]

Array [

cloudConfig

object

required

valuesstring

Machine pool configuration as yaml content

poolConfig

object

Machine pool configuration for the custom cluster

additionalLabels

object

Additional labels to be part of the machine pool

property name*string

isControlPlaneboolean

Whether this pool is for control plane

taints

object[]

Master or worker taints

Array [

effectstring

Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

keystring

The taint key to be applied to a node

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

valuestring

The taint value corresponding to the taint key.

]

useControlPlaneAsWorkerboolean

If IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools

]

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

]

Responses

200

Custom Cluster validation response

application/json

Schema

Schema

machinePools

object

Constraint validator response

results

object[]

Array [

displayNamestring

errors

object[]

Array [

codestring

messagestring

]

namestring

]

profiles

object[]

Array [

packs

object

Constraint validator response

results

object[]

Array [

displayNamestring

errors

object[]

Array [

codestring

messagestring

]

namestring

]

uidstring

Cluster profile uid

]

Example (from schema)

{
  "machinePools": {
    "results": [
      {
        "displayName": "string",
        "errors": [
          {
            "code": "string",
            "message": "string"
          }
        ],
        "name": "string"
      }
    ]
  },
  "profiles": [
    {
      "packs": {
        "results": [
          {
            "displayName": "string",
            "errors": [
              {
                "code": "string",
                "message": "string"
              }
            ],
            "name": "string"
          }
        ]
      },
      "uid": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• java

• CURL

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

cloudType — pathrequired

ProjectUid — header

Body

{
  "metadata": {
    "annotations": {},
    "labels": {},
    "name": "string"
  },
  "spec": {
    "cloudAccountUid": "string",
    "cloudConfig": {
      "values": "string"
    },
    "clusterConfig": {
      "location": {
        "countryCode": "string",
        "countryName": "string",
        "geoLoc": {
          "latitude": 0,
          "longitude": 0
        },
        "regionCode": "string",
        "regionName": "string"
      },
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "2024-07-03T22:20:37.879Z",
          "patchOnBoot": true,
          "rebootIfRequired": true,
          "schedule": "string"
        }
      },
      "resources": {
        "namespaces": [
          {
            "metadata": {
              "annotations": {},
              "labels": {},
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "isRegex": true,
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              },
              "resourceAllocation": {
                "cpuCores": 0,
                "memoryMiB": 0
              }
            }
          }
        ],
        "rbacs": [
          {
            "metadata": {
              "annotations": {},
              "labels": {},
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "bindings": [
                {
                  "namespace": "string",
                  "role": {
                    "kind": "Role",
                    "name": "string"
                  },
                  "subjects": [
                    {
                      "name": "string",
                      "namespace": "string",
                      "type": "User"
                    }
                  ],
                  "type": "RoleBinding"
                }
              ],
              "relatedObject": {
                "kind": "spectrocluster",
                "name": "string",
                "uid": "string"
              }
            }
          }
        ]
      }
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "values": "string"
        },
        "poolConfig": {
          "additionalLabels": {},
          "isControlPlane": true,
          "taints": [
            {
              "effect": "NoSchedule",
              "key": "string",
              "timeAdded": "2024-07-03T22:20:37.879Z",
              "value": "string"
            }
          ],
          "useControlPlaneAsWorker": true
        }
      }
    ],
    "profiles": [
      {
        "packValues": [
          {
            "manifests": [
              {
                "content": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "tag": "string",
            "type": "spectro",
            "values": "string"
          }
        ],
        "replaceWithProfile": "string",
        "uid": "string"
      }
    ]
  }
}