Creates a vSphere cloud config's machine pool
POST/v1/cloudconfigs/vsphere/:configUid/machinePools
Creates a vSphere cloud config's machine pool
Request
Path Parameters
Cluster's cloud config uid
Header Parameters
Scope the request to the specified project uid
- application/json
Body
Array [
]
Array [
]
cloudConfig
required
instanceType
object
DiskGiB is the size of a virtual machine's disk, in GiB. Defaults to the analogue property value in the template from which this machine is cloned.
MemoryMiB is the size of a virtual machine's memory, in MiB. Defaults to the analogue property value in the template from which this machine is cloned.
NumCPUs is the number of virtual processors in a virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.
placements
object[]
Placements configuration Placements If defined, will replace default values defined in VsphereClusterConfig Array means one MachinePool can span across multiple vsphere compute cluster
Cluster is the computecluster in vsphere
Datacenter is the name or inventory path of the datacenter where this machine's VM is created/located.
Datastore is the datastore in which VMs are created/located.
Folder is the folder in which VMs are created/located.
ImageTemplateFolder is the folder in which VMs templates are created/located. if empty will use default value spectro-templates
network
object
NetworkName is the name of the network in which VMs are created/located.
ParentPoolRef Uid to the ParentPool which allocates IPs for this IPPool
support dhcp or static IP, if false, use DHCP
ResourcePool is the resource pool within the above computecluster Cluster
StoragePolicyName of the storage policy to use with this Virtual Machine
UID for this placement
poolConfig
object
Machine pool configuration for the cluster
additionalLabels
object
Additional labels to be part of the machine pool
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
Whether this pool is for control plane
Labels for this machine pool, example: master/worker, gpu, windows
machinePoolProperties
object
Machine pool specific properties
Possible values: [amd64, arm64]
Default value: amd64
Max size of the pool, for scaling
Min size of the pool, for scaling
Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster
Size of the pool, number of nodes/machines
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.
updateStrategy
object
UpdatesStrategy will be used to translate to RollingUpdateStrategy of a MachineDeployment We'll start with default values for the translation, can expose more details later Following is details of parameters translated from the type ScaleOut => maxSurge=1, maxUnavailable=0 ScaleIn => maxSurge=0, maxUnavailable=1
Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]
update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut
If IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools
Responses
- 201
Created successfully
Response Headers
AuditUid
string
Audit uid for the request
- application/json
- Schema
- Example (from schema)
Schema
{
"uid": "string"
}