Update a node pool

put https://api.linode.com/{apiVersion}/lke/clusters/{clusterId}/pools/{poolId}

Updates a node pool's count, labels and taints, and autoscaler configuration.

Linodes are created or deleted to match changes to the Node Pool's count.

Specifying labels or taints on update overwrites any previous values, and updates existing nodes with the new values without a recycle.

Any local storage on deleted Linodes (such as hostPath and emptyDir volumes, or local PersistentVolumes) will be erased.

linode-cli lke pool-update 12345 456 \
  --count 6 \
  --autoscaler.enabled true \
  --autoscaler.max 12 \
  --autoscaler.min 3 \
  --labels '{ "example.com/my-app":"team1", "env":"staging" }' \
  --taints.effect "NoSchedule" \
  --taints.key "example.com/my-app" \
  --taints.value "teamA"


Learn more...

lke:read_write


Learn more...

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

clusterId

integer

required

ID of the Kubernetes cluster to look up.

poolId

integer

required

ID of the Pool to look up.

Body Params

autoscaler

object

When enabled, the number of nodes automatically scales within the defined minimum and maximum values. When making a request, max and min require each other.

count

integer

1 to 100

The number of nodes in the node pool.

labels

object

Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and easily select subsets of objects. To learn more, review Add Labels and Taints to your LKE node pools.

Label key:

A key can contain alphanumeric characters, dashes (-), underscores (_), or dots (.). Start and end it with an alphanumeric character.
If the key begins with a DNS subdomain prefix followed by a single slash, for example example.com/my-app, the maximum total length of the label key is 128 characters. Domain labels can be up to 62 characters after the '/'. The prefix needs to adhere to RFC 1123 DNS subdomain restrictions.
If the key doesn't begin with a DNS subdomain prefix, the maximum key length is 63 characters.

Specifying an empty object removes all previously set labels.

Label value:

The label's value can contain alphanumeric characters, dashes (-), underscores (_), or dots (.). Start and end it with an alphanumeric character.
Can be specified as an empty string value with "".

tags

array of strings

Filterable Organizational tags to apply to this node pool. When you apply tags to LKE Enterprise node pools, they also apply to the nodes (Linodes) within the node pool. Tags don't cascade down to nodes in non-Enterprise node pools.

tags

taints

array of objects

length ≥ 0

Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods. To learn more, review Add labels and taints to your LKE node pools.

Specifying an empty array ([]) removes all previously set taints.

taints

Response

Response body

object

autoscaler

object

When enabled, the number of nodes autoscales within the defined minimum and maximum values.

enabled

boolean

Whether autoscaling is enabled for this node pool. Defaults to false.

max

integer

1 to 100

The maximum number of nodes to autoscale to. Defaults to the node pool's count.

min

integer

1 to 100

The minimum number of nodes to autoscale to. Defaults to the node pool's count.

count

integer

1 to 100

The number of nodes in the node pool.

disk_encryption

string

enum

Indicates the local disk encryption setting for this LKE node pool.

enabled disabled

disks

array of objects

This node pool's custom disk layout.

disks

object

size

integer

The size of this custom disk partition in MB. The size of this disk partition can't exceed the capacity of the node's plan type.

type

string

enum

This custom disk partition's filesystem type.

raw ext4

integer

Filterable This node pool's unique ID.

k8s_version

string

Beta The Kubernetes version used for the worker nodes within this node pool.

🚧
This field is available as part of the beta API and is only returned for accounts that have been enrolled in the LKE Enterprise LA.

label

string

length between 1 and 32

Beta The optional label defined for this node Pool.

🚧
This field is available as part of the beta API and is only returned for accounts that have been enrolled in the LKE Enterprise LA.

labels

object

Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and easily select subsets of objects. To learn more, review Add Labels and Taints to your LKE node pools.

Has additional fields

nodes

array of objects

Status information for the nodes that are members of this node pool. If a Linode has not been provisioned for a given node slot, the instance_id is null.

nodes

object

string

The Node's ID.

instance_id

integer | null

The Linode's ID. When no Linode is currently provisioned for this Node, this will be null.

status

string

enum

The creation status of this Node. This status is distinct from this Node's readiness as a Kubernetes Node Object as determined by the command kubectl get nodes.

not_ready indicates that the Linode is still being created.

ready indicates that the Linode has successfully been created and is running Kubernetes software.

ready not_ready

tags

array of strings

Filterable An array of tags applied to this object. Tags are for organizational purposes only.

tags

taints

array of objects

Kubernetes taints added to nodes in the node pool. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.

taints

object

effect

string

enum

The Kubernetes taint effect. For NoSchedule, PreferNoSchedule and NoExecute descriptions, see Kubernetes Taints and Tolerations.

NoSchedule PreferNoSchedule NoExecute

key

string

length between 1 and 63

The Kubernetes taint key.

value

string

length between 0 and 63

The Kubernetes taint value.

type

string

The Linode Type for all of the nodes in the node pool.

update_strategy

string

enum

Beta Determines when the worker nodes within this node pool upgrade to the latest selected Kubernetes version, after the cluster has been upgraded. This field is required for LKE Enterprise clusters but should not be used for non-enterprise LKE clusters.

rolling_update on_recycle

Language

Credentials


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.linode.com/v4/lke/clusters/clusterId/pools/poolId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Node Pool was successfully modified.

🚧

🚧