Creates a Tke cluster

POST 
https://api.spectrocloud.com/v1/spectroclusters/tke

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header

Creates a Tke cluster

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

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.

Populated by the system. Read-only.

spec object
cloudAccountUidstringrequired
Cloud account uid to be used for cluster provisioning
cloudConfig objectrequired
Cluster level configuration for tencent cloud and applicable for all the machine pools
endpointAccess object
Endpoints specifies access to this cluster's control plane endpoints
IsExtranetboolean
IsExtranet Whether it is external network access (TRUE external network access FALSE internal network access, default value: FALSE)
privateboolean
Private points VPC-internal control plane access to the private endpoint
privateCIDRstring
Deprecated. PrivateCIDRs specifies which blocks can access the public endpoint
publicboolean
Public controls whether control plane endpoints are publicly accessible
publicCIDRsstring[]
Deprecated. PublicCIDRs specifies which blocks can access the public endpoint
securityGroupstring
Tencent security group
subnetIdstring
Tencent Subnet
regionstringrequired
sshKeyIDsstring[]
vpcIDstring
VPC Id to deploy cluster into should have one public and one private subnet for the the cluster creation, this field is optional, If VPC Id is not provided a fully managed VPC will be created
clusterConfig object
General cluster configuration like health, patching settings, namespace resource allocation, rbac
clusterMetaAttributestring
ClusterMetaAttribute can be used to set additional cluster metadata information.
controlPlaneHealthCheckTimeoutstring
hostClusterConfig
clusterEndpoint
host cluster configuration
config
ingressConfig
Ingress configuration for exposing the virtual cluster's kube-apiserver
hoststring
portint64
loadBalancerConfig
Load balancer configuration for exposing the virtual cluster's kube-apiserver
externalIPsstring[]
externalTrafficPolicystring
loadBalancerSourceRangesstring[]
typestring
Possible values: [Ingress, LoadBalancer]
is enabled as host cluster
clusterGroup 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
hostCluster 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
isHostClusterboolean
Default value: false
is enabled as host cluster
lifecycleConfig
pauseboolean
Default value: false
enable pause life cycle config
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
Name of the resource
uidstring
Populated by the system. Read-only.
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
Name of the resource
uidstring
Populated by the system. Read-only.
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
]
updateWorkerPoolsInParallelboolean
machinepoolconfig object[]
Array [
cloudConfig objectrequired
azsstring[]
instanceTypestring
instance type
rootDeviceSizeint64
Possible values: >= 1 and <= 2000
rootDeviceSize in GBs
subnetIds object
AZ to subnet mapping filled by ally from hubble SubnetIDs ["ap-guangzhou-6"] = "subnet-079b6061" This field is optional If we don't provide a subnetId then by default the first subnet from the AZ will be picked up for deployment
property name*string
poolConfig object
Machine pool configuration for the cluster
additionalLabels object
Additional labels to be part of the machine pool
property name*string
additionalTags object
AdditionalTags is an optional set of tags to add to resources managed by the provider, in addition to the ones added by default. For eg., tags for EKS nodeGroup or EKS NodegroupIAMRole
property name*string
isControlPlaneboolean
Whether this pool is for control plane
labelsstring[]required
Labels for this machine pool, example: master/worker, gpu, windows
machinePoolProperties object
Machine pool specific properties
archTypestring
Possible values: [amd64, arm64]
Default value: amd64
Architecture type of the pool. Default value is 'amd64'
maxSizeint32
Max size of the pool, for scaling
minSizeint32
Min size of the pool, for scaling
namestringrequired
nodeRepaveIntervalint32
Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster
sizeint32required
Size of the pool, number of nodes/machines
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.
]
updateStrategy object
Rolling update strategy for this machine pool if not specified, will use ScaleOut
typestring
Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]
update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut
useControlPlaneAsWorkerboolean
If IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools
]
policies object
Cluster policies
backupPolicy
Cluster backup config
backupLocationNamestring
backupLocationUidstring
backupNamestring
backupPrefixstring
durationInHoursint64
includeAllDisksboolean
includeClusterResourcesboolean
locationTypestring
namespacesstring[]
schedule
Cluster feature schedule
scheduledRunTimestring
scanPolicy
Cluster compliance scan schedule configuration
kubeBench
Cluster compliance scan schedule config for kube bench driver
schedule
Cluster feature schedule
scheduledRunTimestring
kubeHunter
Cluster compliance scan schedule config for kube hunter driver
schedule
Cluster feature schedule
scheduledRunTimestring
sonobuoy
Cluster compliance scan schedule config for sonobuoy driver
schedule
Cluster feature schedule
scheduledRunTimestring
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

201

Created successfully

Response Headers

• AuditUid string

  Audit uid for the request

application/json

Schema

Schema

uidstringrequired

Example (from schema)

{
  "uid": "string"
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X POST 'https://api.spectrocloud.com/v1/spectroclusters/tke' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2023-12-01T21:31:48.087Z",
    "deletionTimestamp": "2023-12-01T21:31:48.087Z",
    "labels": {},
    "lastModifiedTimestamp": "2023-12-01T21:31:48.087Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "cloudAccountUid": "string",
    "cloudConfig": {
      "endpointAccess": {
        "IsExtranet": true,
        "private": true,
        "privateCIDR": "string",
        "public": true,
        "publicCIDRs": [
          "string"
        ],
        "securityGroup": "string",
        "subnetId": "string"
      },
      "region": "string",
      "sshKeyIDs": [
        "string"
      ],
      "vpcID": "string"
    },
    "clusterConfig": {
      "clusterMetaAttribute": "string",
      "controlPlaneHealthCheckTimeout": "string",
      "hostClusterConfig": {
        "clusterEndpoint": {
          "config": {
            "ingressConfig": {
              "host": "string",
              "port": 0
            },
            "loadBalancerConfig": {
              "externalIPs": [
                "string"
              ],
              "externalTrafficPolicy": "string",
              "loadBalancerSourceRanges": [
                "string"
              ]
            }
          },
          "type": "Ingress"
        },
        "clusterGroup": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        },
        "hostCluster": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        },
        "isHostCluster": false
      },
      "lifecycleConfig": {
        "pause": false
      },
      "location": {
        "countryCode": "string",
        "countryName": "string",
        "geoLoc": {
          "latitude": 0,
          "longitude": 0
        },
        "regionCode": "string",
        "regionName": "string"
      },
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "2023-12-01T21:31:48.088Z",
          "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"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": true
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "instanceType": "string",
          "rootDeviceSize": 0,
          "subnetIds": {}
        },
        "poolConfig": {
          "additionalLabels": {},
          "additionalTags": {},
          "isControlPlane": true,
          "labels": [
            "string"
          ],
          "machinePoolProperties": {
            "archType": "amd64"
          },
          "maxSize": 0,
          "minSize": 0,
          "name": "string",
          "nodeRepaveInterval": 0,
          "size": 0,
          "taints": [
            {
              "effect": "NoSchedule",
              "key": "string",
              "timeAdded": "2023-12-01T21:31:48.088Z",
              "value": "string"
            }
          ],
          "updateStrategy": {
            "type": "RollingUpdateScaleOut"
          },
          "useControlPlaneAsWorker": true
        }
      }
    ],
    "policies": {
      "backupPolicy": {
        "backupLocationName": "string",
        "backupLocationUid": "string",
        "backupName": "string",
        "backupPrefix": "string",
        "durationInHours": 0,
        "includeAllDisks": true,
        "includeClusterResources": true,
        "locationType": "string",
        "namespaces": [
          "string"
        ],
        "schedule": {
          "scheduledRunTime": "string"
        }
      },
      "scanPolicy": {
        "kubeBench": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "kubeHunter": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "sonobuoy": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        }
      }
    },
    "profiles": [
      {
        "packValues": [
          {
            "manifests": [
              {
                "content": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "tag": "string",
            "type": "spectro",
            "values": "string"
          }
        ],
        "replaceWithProfile": "string",
        "uid": "string"
      }
    ]
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

ProjectUid — header

Body

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2023-12-01T21:31:48.087Z",
    "deletionTimestamp": "2023-12-01T21:31:48.087Z",
    "labels": {},
    "lastModifiedTimestamp": "2023-12-01T21:31:48.087Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "cloudAccountUid": "string",
    "cloudConfig": {
      "endpointAccess": {
        "IsExtranet": true,
        "private": true,
        "privateCIDR": "string",
        "public": true,
        "publicCIDRs": [
          "string"
        ],
        "securityGroup": "string",
        "subnetId": "string"
      },
      "region": "string",
      "sshKeyIDs": [
        "string"
      ],
      "vpcID": "string"
    },
    "clusterConfig": {
      "clusterMetaAttribute": "string",
      "controlPlaneHealthCheckTimeout": "string",
      "hostClusterConfig": {
        "clusterEndpoint": {
          "config": {
            "ingressConfig": {
              "host": "string",
              "port": 0
            },
            "loadBalancerConfig": {
              "externalIPs": [
                "string"
              ],
              "externalTrafficPolicy": "string",
              "loadBalancerSourceRanges": [
                "string"
              ]
            }
          },
          "type": "Ingress"
        },
        "clusterGroup": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        },
        "hostCluster": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        },
        "isHostCluster": false
      },
      "lifecycleConfig": {
        "pause": false
      },
      "location": {
        "countryCode": "string",
        "countryName": "string",
        "geoLoc": {
          "latitude": 0,
          "longitude": 0
        },
        "regionCode": "string",
        "regionName": "string"
      },
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "2023-12-01T21:31:48.088Z",
          "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"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": true
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "instanceType": "string",
          "rootDeviceSize": 0,
          "subnetIds": {}
        },
        "poolConfig": {
          "additionalLabels": {},
          "additionalTags": {},
          "isControlPlane": true,
          "labels": [
            "string"
          ],
          "machinePoolProperties": {
            "archType": "amd64"
          },
          "maxSize": 0,
          "minSize": 0,
          "name": "string",
          "nodeRepaveInterval": 0,
          "size": 0,
          "taints": [
            {
              "effect": "NoSchedule",
              "key": "string",
              "timeAdded": "2023-12-01T21:31:48.088Z",
              "value": "string"
            }
          ],
          "updateStrategy": {
            "type": "RollingUpdateScaleOut"
          },
          "useControlPlaneAsWorker": true
        }
      }
    ],
    "policies": {
      "backupPolicy": {
        "backupLocationName": "string",
        "backupLocationUid": "string",
        "backupName": "string",
        "backupPrefix": "string",
        "durationInHours": 0,
        "includeAllDisks": true,
        "includeClusterResources": true,
        "locationType": "string",
        "namespaces": [
          "string"
        ],
        "schedule": {
          "scheduledRunTime": "string"
        }
      },
      "scanPolicy": {
        "kubeBench": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "kubeHunter": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "sonobuoy": {
          "schedule": {
            "scheduledRunTime": "string"
          }
        }
      }
    },
    "profiles": [
      {
        "packValues": [
          {
            "manifests": [
              {
                "content": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "tag": "string",
            "type": "spectro",
            "values": "string"
          }
        ],
        "replaceWithProfile": "string",
        "uid": "string"
      }
    ]
  }
}