Node Pools

Contents

Node pools

Node pools represent a set of computational nodes that live inside a Kubernetes clusters. These node pools can be deployed by a user on a cluster already deployed on a cloud provider.

Show node pool

GET /v3/kubernetes/node_pools/:id

This action returns information about the node pool identified by the given id.

Inputs

None

Returns

Field Type Description
id String Identifier of the node pool.
name String Logical name of the node pool.
cluster_id String Identifier of the cluster which the node pool belongs.
remote_id String Identifier of the node pool on the cloud provider.
state String State of the node pool. It can be one of these values: start, applying, applied, decommissioning, application_error, decommission_error, end.
node_pool_plan_id String Identifier of the node pool plan that this node pool is based.
subnet_id String Identifier of the subnet where this node pool is deployed.
disk_size Integer Size of the disk each node of the node pool will have, expressed in Gigabytes (GB).
os_type String Type of Operative System each node of the node pool will have.
cpu_type String Type of CPU each node of the node pools will have.
min_nodes Integer Minimum number of nodes the node pool will have.
max_nodes Integer Maximum number of nodes the node pool will have.
desired_nodes Integer Amount of nodes the node pool will tend to have if the node pool does not have autoscaling.
pods_per_node Integer Amount of pods each node of the node pool will have if the node pool plan has pods_per_node_presence set as true.
brownfield Boolean Flag indicating if the node pool has been imported from a cloud account (true) or created using IMCO (false).
resource_type String An identifier for the type of resource, specifically "node_pool".

Back to top

Create node pool

POST /v3/kubernetes/clusters/:cluster_id/node_pools

This action creates a new node pool inside the cluster identified by the given id.

Inputs

Field Type Description Required
name String Logical name of the node pool. Yes           
disk_size Integer Size of the disk each node of the node pool will have, expressed in Gigabytes (GB). No
cpu_type String Type of CPU each node of the node pools will have. Can be nil only if the node pool plan does not have any cpu types Yes
min_nodes Integer Minimum number of nodes the node pool will have. No
max_nodes Integer Maximum number of nodes the node pool will have. No
desired_nodes Integer Amount of nodes the node pool will tend to have if the node pool does not have autoscaling. No
pods_per_node Integer Amount of pods each node of the node pool will have if the node pool plan has pods_per_node_presence set as true. Can be nil if pods_per_node_presence is false on the node pool plan No
subnet_id String Identifier of the subnet where this node pool is deployed. Must be nil for a node pool inside a brownfield cluster that has a cluster plan with autoscaling capable set as true but the cluster has autoscaling as false. Yes
node_pool_plan_id String Identifier of the node pool plan that this node pool is based. Yes

Returns

Field Type Description
id String Identifier of the node pool.
name String Logical name of the node pool.
cluster_id String Identifier of the cluster which the node pool belongs.
remote_id String Identifier of the node pool on the cloud provider.
state String State of the node pool. It can be one of these values: start, applying, applied, decommissioning, application_error, decommission_error, end.
node_pool_plan_id String Identifier of the node pool plan that this node pool is based.
subnet_id String Identifier of the subnet where this node pool is deployed.
disk_size Integer Size of the disk each node of the node pool will have, expressed in Gigabytes (GB).
os_type String Type of Operative System each node of the node pool will have.
cpu_type String Type of CPU each node of the node pools will have.
min_nodes Integer Minimum number of nodes the node pool will have.
max_nodes Integer Maximum number of nodes the node pool will have.
desired_nodes Integer Amount of nodes the node pool will tend to have if the node pool does not have autoscaling.
pods_per_node Integer Amount of pods each node of the node pool will have if the node pool plan has pods_per_node_presence set as true.
brownfield Boolean Flag indicating if the node pool has been imported from a cloud account (true) or created using IMCO (false).
resource_type String An identifier for the type of resource, specifically "node_pool".

Back to top

Update node pool

PUT /v3/kubernetes/node_pools/:id

This action modifies the node pool with the given parameters.

Inputs

Field Type Description Required
name String Logical name of the cluster. No
min_nodes Integer Minimum number of nodes the node pool will have. No
max_nodes Integer Maximum number of nodes the node pool will have. No
desired_nodes Integer Amount of nodes the node pool will tend to have if the node pool does not have autoscaling. No

Returns

Field Type Description
id String Identifier of the node pool.
name String Logical name of the node pool.
cluster_id String Identifier of the cluster which the node pool belongs.
remote_id String Identifier of the node pool on the cloud provider.
state String State of the node pool. It can be one of these values: start, applying, applied, decommissioning, application_error, decommission_error, end.
node_pool_plan_id String Identifier of the node pool plan that this node pool is based.
subnet_id String Identifier of the subnet where this node pool is deployed.
disk_size Integer Size of the disk each node of the node pool will have, expressed in Gigabytes (GB).
os_type String Type of Operative System each node of the node pool will have.
cpu_type String Type of CPU each node of the node pools will have.
min_nodes Integer Minimum number of nodes the node pool will have.
max_nodes Integer Maximum number of nodes the node pool will have.
desired_nodes Integer Amount of nodes the node pool will tend to have if the node pool does not have autoscaling.
pods_per_node Integer Amount of pods each node of the node pool will have if the node pool plan has pods_per_node_presence set as true.
brownfield Boolean Flag indicating if the node pool has been imported from a cloud account (true) or created using IMCO (false).
resource_type String An identifier for the type of resource, specifically "node_pool".

Back to top

Delete node pool

DELETE /v3/kubernetes/node_pools/:id

This action deletes the node pool with the given id.

Inputs

None

Returns

Field Type Description
id String Identifier of the node pool.
name String Logical name of the node pool.
cluster_id String Identifier of the cluster which the node pool belongs.
remote_id String Identifier of the node pool on the cloud provider.
state String State of the node pool. It can be one of these values: start, applying, applied, decommissioning, application_error, decommission_error, end.
node_pool_plan_id String Identifier of the node pool plan that this node pool is based.
subnet_id String Identifier of the subnet where this node pool is deployed.
disk_size Integer Size of the disk each node of the node pool will have, expressed in Gigabytes (GB).
os_type String Type of Operative System each node of the node pool will have.
cpu_type String Type of CPU each node of the node pools will have.
min_nodes Integer Minimum number of nodes the node pool will have.
max_nodes Integer Maximum number of nodes the node pool will have.
desired_nodes Integer Amount of nodes the node pool will tend to have if the node pool does not have autoscaling.
pods_per_node Integer Amount of pods each node of the node pool will have if the node pool plan has pods_per_node_presence set as true.
brownfield Boolean Flag indicating if the node pool has been imported from a cloud account (true) or created using IMCO (false).
resource_type String An identifier for the type of resource, specifically "node_pool".

Back to top

Retry node pool

PUT /v3/kubernetes/node_pools/:id/retry

This action retries the application of a node pool with the given id on IMCO.

Inputs

None

Returns

Field Type Description
id String Identifier of the node pool.
name String Logical name of the node pool.
cluster_id String Identifier of the cluster which the node pool belongs.
remote_id String Identifier of the node pool on the cloud provider.
state String State of the node pool. It can be one of these values: start, applying, applied, decommissioning, application_error, decommission_error, end.
node_pool_plan_id String Identifier of the node pool plan that this node pool is based.
subnet_id String Identifier of the subnet where this node pool is deployed.
disk_size Integer Size of the disk each node of the node pool will have, expressed in Gigabytes (GB).
os_type String Type of Operative System each node of the node pool will have.
cpu_type String Type of CPU each node of the node pools will have.
min_nodes Integer Minimum number of nodes the node pool will have.
max_nodes Integer Maximum number of nodes the node pool will have.
desired_nodes Integer Amount of nodes the node pool will tend to have if the node pool does not have autoscaling.
pods_per_node Integer Amount of pods each node of the node pool will have if the node pool plan has pods_per_node_presence set as true.
brownfield Boolean Flag indicating if the node pool has been imported from a cloud account (true) or created using IMCO (false).
resource_type String An identifier for the type of resource, specifically "node_pool".

Back to top