Skip to main content

Creates a CoxEdge cloud config's machine pool

POST 
/v1/cloudconfigs/coxedge/:configUid/machinePools

Creates a CoxEdge cloud config's machine pool

Request​

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    cloudConfig objectrequired
    deployments undefined[]
  • Array [
    • cpuUtilizationint32
    enableAutoScalingboolean
    instancesPerPopint32
    maxInstancesPerPopint32
    minInstancesPerPopint32
    namestring
    popsstring[]
  • ]
    • persistentStorages object[]

    Array of coxedge load persistent storages

  • Array [
    • pathstring

    Coxedge load persistent storage path

    sizeint64

    Coxedge load persistent storage size

  • ]
    • securityGroupRules undefined[]
  • Array [
    • actionstring

    Possible values: [block, allow]

    descriptionstring
    portRangestring
    protocolstring

    Possible values: [TCP, UDP, TCP_UDP, ESP, AH, ICMP, GRE]

    sourcestring
    typestring
  • ]
    • specstring
    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

Responses​

Created successfully

Response Headers
  • AuditUid string

    Audit uid for the request

Schema
    uidstringrequired
Loading...