Skip to main content

clusters_pools

Overview

Nameclusters_pools
TypeResource
Idlinode.lke.clusters_pools

Fields

NameDatatypeDescription
idintegerThis Node Pool's unique ID.
nodesarrayStatus information for the Nodes which are members of this Node Pool. If a Linode has not been provisioned for a given Node slot, the instance_id will be returned as null.
tagsarrayAn array of tags applied to this object. Tags are for organizational purposes only.
typestringThe Linode Type for all of the nodes in the Node Pool.
autoscalerobjectWhen enabled, the number of nodes autoscales within the defined minimum and maximum values.
countintegerThe number of nodes in the Node Pool.
disksarrayThis Node Pool's custom disk layout.

Methods

NameAccessible byRequired ParamsDescription
getLKEClusterPoolsSELECTclusterIdReturns all active Node Pools on a Kubernetes cluster.
getLKENodePoolSELECTclusterId, poolIdGet a specific Node Pool by ID.
deleteLKENodePoolDELETEclusterId, poolIdDelete a specific Node Pool from a Kubernetes cluster.

Deleting a Node Pool is a destructive action and cannot be undone.

Deleting a Node Pool will delete all Linodes within that Pool.
_getLKEClusterPoolsEXECclusterIdReturns all active Node Pools on a Kubernetes cluster.
_getLKENodePoolEXECclusterId, poolIdGet a specific Node Pool by ID.
postLKEClusterPoolRecycleEXECclusterId, poolIdRecycles a Node Pool for the designated Kubernetes Cluster. All Linodes within the Node Pool will be deleted
and replaced with new Linodes on a rolling basis, which may take several minutes. Replacement Nodes are
installed with the latest available patch for the Cluster's Kubernetes Version.

Any local storage on deleted Linodes (such as "hostPath" and "emptyDir" volumes, or "local" PersistentVolumes) will be erased.
postLKEClusterPoolsEXECclusterId, data__count, data__typeCreates a new Node Pool for the designated Kubernetes cluster.
putLKENodePoolEXECclusterId, poolIdUpdates a Node Pool's count and autoscaler configuration.

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

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