Skip to main content

Updates the specified EKS cloud config's machine pool

PUT 
/v1/cloudconfigs/eks/:configUid/machinePools/:machinePoolName

Updates the specified EKS cloud config's machine pool

Request​

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

    machinePoolName stringrequired

    Machine pool name

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    cloudConfig

    awsLaunchTemplate

    object

    AWSLaunchTemplate specifies the launch template to use to create the managed node group

    additionalSecurityGroups

    object[]

    AdditionalSecurityGroups is an array of references to security groups that should be applied to the instances

  • Array [

    • arnstring

    ARN of resource

    filters

    object[]

    Filters is a set of key/value pairs used to identify a resource

  • Array [

    • namestring

    Name of the filter. Filter names are case-sensitive

    valuesstring[]

    Values includes one or more filter values. Filter values are case-sensitive

  • ]

    • idstring

    ID of resource

  • ]

    • ami

    object

    AMI is the reference to the AMI from which to create the machine instance

    eksOptimizedLookupTypestring

    Possible values: [AmazonLinux, AmazonLinuxGPU]

    EKSOptimizedLookupType If specified, will look up an EKS Optimized image in SSM Parameter store

    idstring

    ID of resource

    imageLookupBaseOSstring

    ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set

    imageLookupFormatstring

    ImageLookupFormat is the AMI naming format to look up the image

    imageLookupOrgstring

    ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set

    rootVolume

    object

    Volume encapsulates the configuration options for the storage device.

    deviceNamestring

    Device name

    encryptedboolean

    EncryptionKey is the KMS key to use to encrypt the volume. Can be either a KMS key ID or ARN

    encryptionKeystring

    EncryptionKey is the KMS key to use to encrypt the volume. Can be either a KMS key ID or ARN

    iopsint64

    IOPS is the number of IOPS requested for the disk. Not applicable to all types

    throughputint64

    Throughput to provision in MiB/s supported for the volume type. Not applicable to all types.

    typestring

    Type is the type of the volume (e.g. gp2, io1, etc...)

    azsstring[]
    capacityTypestring

    Possible values: [on-demand, spot]

    Default value: on-demand

    EC2 instance capacity type

    enableAwsLaunchTemplateboolean

    flag to know if aws launch template is enabled

    instanceTypestring

    instance type

    rootDeviceSizeint64

    Possible values: >= 1 and <= 2000

    rootDeviceSize in GBs

    spotMarketOptions

    object

    SpotMarketOptions defines the options available to a user when configuring Machines to run on Spot instances. Most users should provide an empty struct.

    maxPricestring

    MaxPrice defines the maximum price the user is willing to pay for Spot VM instances

    subnets

    undefined[]

  • Array [

    • azstring
    idstring

  • ]

    • 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

    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

    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

    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​

The resource was updated successfully

Loading...