node_pools

Overview

Name	node_pools
Type	Resource
Id	digitalocean.kubernetes.node_pools

Fields

Name	Datatype	Description
id	string	A unique ID that can be used to identify and reference a specific node pool.
name	string	A human-readable name for the node pool.
auto_scale	boolean	A boolean value indicating whether auto-scaling is enabled for this node pool.
count	integer	The number of Droplet instances in the node pool.
labels	object	An object containing a set of Kubernetes labels. The keys and are values are both user-defined.
max_nodes	integer	The maximum number of nodes that this node pool can be auto-scaled to. The value will be 0 if auto_scale is set to false.
min_nodes	integer	The minimum number of nodes that this node pool can be auto-scaled to. The value will be 0 if auto_scale is set to false.
nodes	array	An object specifying the details of a specific worker node in a node pool.
size	string	The slug identifier for the type of Droplet used as workers in the node pool.
tags	array	An array containing the tags applied to the node pool. All node pools are automatically tagged k8s, k8s-worker, and k8s:$K8S_CLUSTER_ID.
taints	array	An array of taints to apply to all nodes in a pool. Taints will automatically be applied to all existing nodes and any subsequent nodes added to the pool. When a taint is removed, it is removed from all nodes in the pool.

Methods

Name	Accessible by	Required Params	Description
get_nodePool	SELECT	cluster_id, node_pool_id	To show information about a specific node pool in a Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID.
list_nodePools	SELECT	cluster_id	To list all of the node pools in a Kubernetes clusters, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools.
add_nodePool	INSERT	cluster_id, data__count, data__name, data__size	To add an additional node pool to a Kubernetes clusters, send a POST request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools with the following attributes.
delete_nodePool	DELETE	cluster_id, node_pool_id	To delete a node pool, send a DELETE request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID. A 204 status code with no body will be returned in response to a successful request. Nodes in the pool will subsequently be drained and deleted.
_get_nodePool	EXEC	cluster_id, node_pool_id	To show information about a specific node pool in a Kubernetes cluster, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID.
_list_nodePools	EXEC	cluster_id	To list all of the node pools in a Kubernetes clusters, send a GET request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools.
recycle_node_pool	EXEC	cluster_id, node_pool_id	The endpoint has been deprecated. Please use the DELETE /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID/nodes/$NODE_ID method instead.
update_nodePool	EXEC	cluster_id, node_pool_id, data__count, data__name	To update the name of a node pool, edit the tags applied to it, or adjust its number of nodes, send a PUT request to /v2/kubernetes/clusters/$K8S_CLUSTER_ID/node_pools/$NODE_POOL_ID with the following attributes.