Update a node pool

Updates a node pool's count, labels, 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.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

  • Identity and access permissions. Your user needs a role with these permissions. Learn more.

    • Roles: lkecluster_admin
  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: lke:read_write

CLI

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

Path Params
string
enum
required

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

Allowed:
integer
required

ID of the Kubernetes cluster to look up.

integer
required

ID of the Pool to look up.

Body Params

The fields to update.

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.

integer
1 to 100

The number of nodes in the node pool.

integer

Beta, LKE Enterprise The id of the Cloud Firewall that you wish to assign to this node pool. Review Recommended firewall settings to learn which rules should be configured within your firewall for compatibility with LKE.

📘

If you add, modify, or remove the firewall ID on an existing node pool, you must recycle the node pool to apply the changes.

🚧

This field is available as part of the beta API and can only be used by accounts with access to LKE Enterprise. Call the URL with the apiVersion path parameter set to v4beta.

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 the Labels and taints guide.

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 the Labels and taints guide.

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

taints
Response

Language
Credentials
Response
Choose an example:
application/json