Creates a Custom cluster
POST/v1/spectroclusters/cloudTypes/:cloudType
Creates a Custom cluster
Request
Path Parameters
Cluster's cloud type
Header Parameters
Scope the request to the specified project uid
- application/json
Body
Array [
]
Array [
Array [
Array [
]
]
]
Array [
Array [
]
]
Array [
Array [
Array [
]
]
]
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.
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
Name of the resource.
spec
object
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
YAML string for Cluster and CloudCluster
clusterConfig
object
location
object
Cluster location information
country code for cluster location
country name for cluster location
geoLoc
object
Geolocation Latlong entity
Latitude of a resource
Longitude of a resource
region code for cluster location
region name for cluster location
machineManagementConfig
object
osPatchConfig
object
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.
PatchOnBoot indicates need to do patch when node first boot up, only once
Reboot once the OS patch is applied
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[]
metadata
object
ObjectMeta update entity with uid as input
annotations
object
labels
object
spec
Cluster namespace spec
relatedObject
object
Object for which the resource is related
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
resourceAllocation
Cluster namespace resource allocation
rbacs
object[]
metadata
object
ObjectMeta update entity with uid as input
annotations
object
labels
object
spec
object
Cluster RBAC spec
bindings
object[]
role
object
Cluster role ref
Possible values: [Role, ClusterRole]
subjects
object[]
Possible values: [User, Group, ServiceAccount]
Possible values: [RoleBinding, ClusterRoleBinding]
relatedObject
object
Object for which the resource is related
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
machinepoolconfig
object[]
cloudConfig
object
required
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
Whether this pool is for control plane
taints
object[]
Master or worker taints
Possible values: [NoSchedule, PreferNoSchedule, NoExecute]
The taint key to be applied to a node
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.
The taint value corresponding to the taint key.
If IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools
profiles
object[]
packValues
object[]
Cluster profile packs array
manifests
undefined[]
Pack manifests are additional content as part of the profile
Manifest content in yaml
Manifest name
Manifest uid
Pack name
Pack version tag
Possible values: [spectro, helm, manifest, oci]
Default value: spectro
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
Cluster profile uid to be replaced with new profile
Cluster profile uid
Responses
- 201
Created successfully
Response Headers
AuditUid
string
Audit uid for the request
- application/json
- Schema
- Example (from schema)
Schema
{
"uid": "string"
}