Pools

Defines the system volume disk type. Several types of volume (volume_type) are provided:.

l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
sbs_5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
sbs_15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, use sbs_5k or sbs_15k instead.

Enum values:

default_volume_type

l_ssd

b_ssd

sbs_5k

sbs_15k

Default: default_volume_type

root_volume_size

integer | null · uint64

System volume disk size. (in bytes)

public_ip_disabled

boolean

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

security_group_id

string | null

Security group ID in which all the nodes of the pool will be created. If unset, the pool will use default Kapsule security group in current zone.

object

Kubernetes labels applied and reconciled on the nodes.

Kubernetes taints applied and reconciled on the nodes.

Kubernetes taints applied at node creation but not reconciled afterwards.

object

User data applied and reconciled with the pool.

max_termination_grace_period

string | null

Maximum amount of time before the API forces the drain and deletion of a deleting node. It overrides pods PodDisruptionBudget and terminationGracePeriodSeconds. Defaults to 15 minutes, up to 1 hour. (in seconds)

Create a new Pool in a Cluster › Responses

200

node_type

string · required

size

integer · uint32 · required

Size (number of nodes) of the pool.

id

string

Pool ID. (UUID format)

cluster_id

string

Cluster ID of the pool. (UUID format)

created_at

string | null · date-time

Date on which the pool was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the pool was last updated. (RFC 3339 format)

name

string

Pool name.

status

scaleway.k8s.v1.Pool.Status · enum

Pool status.

Enum values:

unknown

ready

deleting

deleted

scaling

warning

locked

upgrading

Default: unknown

version

string

Pool version.

autoscaling

boolean

Defines whether the autoscaling feature is enabled for the pool.

min_size

integer · uint32

Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

max_size

integer · uint32

Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

container_runtime

scaleway.k8s.v1.Runtime · enum

Customization of the container runtime is available for each pool.

Enum values:

unknown_runtime

containerd

Default: unknown_runtime

autohealing

boolean

Defines whether the autohealing feature is enabled for the pool.

tags

string[]

Tags associated with the pool, see managing tagsOpen in new context.

placement_group_id

string | null

Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. (UUID format)

object

Kubelet arguments to be used by this pool. Note that this feature is experimental.

Defines how node provisioning should behave during pool version upgrade.

zone

string

Zone in which the pool's nodes will be spawned.

root_volume_type

Defines the system volume disk type. Several types of volume (volume_type) are provided:.

l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
sbs_5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
sbs_15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, use sbs_5k or sbs_15k instead.

Enum values:

default_volume_type

l_ssd

b_ssd

sbs_5k

sbs_15k

Default: default_volume_type

root_volume_size

integer | null · uint64

System volume disk size. (in bytes)

public_ip_disabled

boolean

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

security_group_id

string

Security group ID in which all the nodes of the pool will be created. If unset, the pool will use default Kapsule security group in current zone. (UUID format)

object

Kubernetes labels applied and reconciled on the nodes.

Kubernetes taints applied and reconciled on the nodes.

Kubernetes taints applied at node creation but not reconciled afterwards.

error_message

string | null

Details of the error, if any occurred when managing the pool.

max_termination_grace_period

string | null

srn

string

The SRN of the pool.

region

string

Cluster region of the pool.

POST/k8s/v1/regions/{region}/clusters/{cluster_id}/pools

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "autohealing": false,
    "autoscaling": false,
    "kubelet_args": {
        "<kubelet_argKey>": "string"
    },
    "labels": {
        "<labelKey>": "string"
    },
    "name": "string",
    "node_type": "string",
    "public_ip_disabled": false,
    "size": 42,
    "user_data": {
        "<user_dataKey>": "string"
    },
    "zone": "string"
  }' \
  "https://api.scaleway.com/k8s/v1/regions/{region}/clusters/{cluster_id}/pools"

Example Request Body

{
  "name": "name",
  "node_type": "node_type",
  "placement_group_id": "placement_group_id",
  "autoscaling": true,
  "size": 0,
  "min_size": 0,
  "max_size": 0,
  "container_runtime": "unknown_runtime",
  "autohealing": true,
  "tags": [
    "string"
  ],
  "kubelet_args": {
    "<kubelet_argKey>": "<kubelet_argKey>"
  },
  "upgrade_policy": {
    "max_unavailable": 0,
    "max_surge": 0
  },
  "zone": "zone",
  "root_volume_type": "default_volume_type",
  "root_volume_size": 0,
  "public_ip_disabled": true,
  "security_group_id": "security_group_id",
  "labels": {
    "<labelKey>": "<labelKey>"
  },
  "taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "startup_taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "user_data": {
    "<user_dataKey>": "<user_dataKey>"
  },
  "max_termination_grace_period": "2.5s"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "cluster_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "node_type": "node_type",
  "autoscaling": true,
  "size": 0,
  "min_size": 0,
  "max_size": 0,
  "container_runtime": "unknown_runtime",
  "autohealing": true,
  "tags": [
    "string"
  ],
  "placement_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "kubelet_args": {
    "<kubelet_argKey>": "<kubelet_argKey>"
  },
  "upgrade_policy": {
    "max_unavailable": 0,
    "max_surge": 0
  },
  "zone": "zone",
  "root_volume_type": "default_volume_type",
  "root_volume_size": 0,
  "public_ip_disabled": true,
  "security_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "labels": {
    "<labelKey>": "<labelKey>"
  },
  "taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "startup_taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "error_message": "error_message",
  "max_termination_grace_period": "2.5s",
  "srn": "srn",
  "region": "region"
}

json

application/json

Get a Pool in a Cluster

GET

https://api.scaleway.com

/k8s/v1/regions/{region}/pools/{pool_id}

Retrieve details about a specific pool in a Kubernetes cluster.

Get a Pool in a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

pool_id

string · required

ID of the requested pool.

Get a Pool in a Cluster › Responses

200

node_type

string · required

size

integer · uint32 · required

Size (number of nodes) of the pool.

id

string

Pool ID. (UUID format)

cluster_id

string

Cluster ID of the pool. (UUID format)

created_at

string | null · date-time

Date on which the pool was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the pool was last updated. (RFC 3339 format)

name

string

Pool name.

status

scaleway.k8s.v1.Pool.Status · enum

Pool status.

Enum values:

unknown

ready

deleting

deleted

scaling

warning

locked

upgrading

Default: unknown

version

string

Pool version.

autoscaling

boolean

Defines whether the autoscaling feature is enabled for the pool.

min_size

integer · uint32

Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

max_size

integer · uint32

Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

container_runtime

scaleway.k8s.v1.Runtime · enum

Customization of the container runtime is available for each pool.

Enum values:

unknown_runtime

containerd

Default: unknown_runtime

autohealing

boolean

Defines whether the autohealing feature is enabled for the pool.

tags

string[]

Tags associated with the pool, see managing tagsOpen in new context.

placement_group_id

string | null

Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. (UUID format)

object

Kubelet arguments to be used by this pool. Note that this feature is experimental.

Defines how node provisioning should behave during pool version upgrade.

zone

string

Zone in which the pool's nodes will be spawned.

root_volume_type

Defines the system volume disk type. Several types of volume (volume_type) are provided:.

l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
sbs_5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
sbs_15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, use sbs_5k or sbs_15k instead.

Enum values:

default_volume_type

l_ssd

b_ssd

sbs_5k

sbs_15k

Default: default_volume_type

root_volume_size

integer | null · uint64

System volume disk size. (in bytes)

public_ip_disabled

boolean

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

security_group_id

string

Security group ID in which all the nodes of the pool will be created. If unset, the pool will use default Kapsule security group in current zone. (UUID format)

object

Kubernetes labels applied and reconciled on the nodes.

Kubernetes taints applied and reconciled on the nodes.

Kubernetes taints applied at node creation but not reconciled afterwards.

error_message

string | null

Details of the error, if any occurred when managing the pool.

max_termination_grace_period

string | null

srn

string

The SRN of the pool.

region

string

Cluster region of the pool.

GET/k8s/v1/regions/{region}/pools/{pool_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/k8s/v1/regions/{region}/pools/{pool_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "cluster_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "node_type": "node_type",
  "autoscaling": true,
  "size": 0,
  "min_size": 0,
  "max_size": 0,
  "container_runtime": "unknown_runtime",
  "autohealing": true,
  "tags": [
    "string"
  ],
  "placement_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "kubelet_args": {
    "<kubelet_argKey>": "<kubelet_argKey>"
  },
  "upgrade_policy": {
    "max_unavailable": 0,
    "max_surge": 0
  },
  "zone": "zone",
  "root_volume_type": "default_volume_type",
  "root_volume_size": 0,
  "public_ip_disabled": true,
  "security_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "labels": {
    "<labelKey>": "<labelKey>"
  },
  "taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "startup_taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "error_message": "error_message",
  "max_termination_grace_period": "2.5s",
  "srn": "srn",
  "region": "region"
}

json

application/json

Delete a Pool in a Cluster

DELETE

https://api.scaleway.com

/k8s/v1/regions/{region}/pools/{pool_id}

Delete a specific pool from a cluster. Note that all the pool's nodes will also be deleted.

Delete a Pool in a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

pool_id

string · required

ID of the pool to delete.

Delete a Pool in a Cluster › Responses

200

node_type

string · required

size

integer · uint32 · required

Size (number of nodes) of the pool.

id

string

Pool ID. (UUID format)

cluster_id

string

Cluster ID of the pool. (UUID format)

created_at

string | null · date-time

Date on which the pool was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the pool was last updated. (RFC 3339 format)

name

string

Pool name.

status

scaleway.k8s.v1.Pool.Status · enum

Pool status.

Enum values:

unknown

ready

deleting

deleted

scaling

warning

locked

upgrading

Default: unknown

version

string

Pool version.

autoscaling

boolean

Defines whether the autoscaling feature is enabled for the pool.

min_size

integer · uint32

Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

max_size

integer · uint32

Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

container_runtime

scaleway.k8s.v1.Runtime · enum

Customization of the container runtime is available for each pool.

Enum values:

unknown_runtime

containerd

Default: unknown_runtime

autohealing

boolean

Defines whether the autohealing feature is enabled for the pool.

tags

string[]

Tags associated with the pool, see managing tagsOpen in new context.

placement_group_id

string | null

Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. (UUID format)

object

Kubelet arguments to be used by this pool. Note that this feature is experimental.

Defines how node provisioning should behave during pool version upgrade.

zone

string

Zone in which the pool's nodes will be spawned.

root_volume_type

Defines the system volume disk type. Several types of volume (volume_type) are provided:.

l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
sbs_5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
sbs_15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, use sbs_5k or sbs_15k instead.

Enum values:

default_volume_type

l_ssd

b_ssd

sbs_5k

sbs_15k

Default: default_volume_type

root_volume_size

integer | null · uint64

System volume disk size. (in bytes)

public_ip_disabled

boolean

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

security_group_id

string

Security group ID in which all the nodes of the pool will be created. If unset, the pool will use default Kapsule security group in current zone. (UUID format)

object

Kubernetes labels applied and reconciled on the nodes.

Kubernetes taints applied and reconciled on the nodes.

scaleway.k8s.v1.UpdatePoolRequest.UpgradePolicy

Kubernetes taints applied at node creation but not reconciled afterwards.

error_message

string | null

Details of the error, if any occurred when managing the pool.

max_termination_grace_period

string | null

srn

string

The SRN of the pool.

region

string

Cluster region of the pool.

DELETE/k8s/v1/regions/{region}/pools/{pool_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/k8s/v1/regions/{region}/pools/{pool_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "cluster_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "node_type": "node_type",
  "autoscaling": true,
  "size": 0,
  "min_size": 0,
  "max_size": 0,
  "container_runtime": "unknown_runtime",
  "autohealing": true,
  "tags": [
    "string"
  ],
  "placement_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "kubelet_args": {
    "<kubelet_argKey>": "<kubelet_argKey>"
  },
  "upgrade_policy": {
    "max_unavailable": 0,
    "max_surge": 0
  },
  "zone": "zone",
  "root_volume_type": "default_volume_type",
  "root_volume_size": 0,
  "public_ip_disabled": true,
  "security_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "labels": {
    "<labelKey>": "<labelKey>"
  },
  "taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "startup_taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "error_message": "error_message",
  "max_termination_grace_period": "2.5s",
  "srn": "srn",
  "region": "region"
}

json

application/json

Update a Pool in a Cluster

PATCH

https://api.scaleway.com

/k8s/v1/regions/{region}/pools/{pool_id}

Update the attributes of a specific pool, such as its desired size, autoscaling settings, and tags. To upgrade a pool, you will need to use the dedicated endpoint.

Update a Pool in a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

pool_id

string · required

ID of the pool to update.

Update a Pool in a Cluster › Request Body

autoscaling

boolean | null

New value for the pool autoscaling enablement.

size

integer | null · uint32

New desired pool size.

min_size

integer | null · uint32

New minimum size for the pool.

max_size

integer | null · uint32

New maximum size for the pool.

autohealing

boolean | null

New value for the pool autohealing enablement.

tags

array | null

New tags associated with the pool.

kubelet_args

object | null

New Kubelet arguments to be used by this pool. Note that this feature is experimental.

New upgrade policy for the pool.

security_group_id

string | null

Security group ID in which all the nodes of the pool will be moved.

max_termination_grace_period

string | null

New maximum amount of time before the API forces the drain and deletion of a deleting node. (in seconds)

Update a Pool in a Cluster › Responses

200

node_type

string · required

size

integer · uint32 · required

Size (number of nodes) of the pool.

id

string

Pool ID. (UUID format)

cluster_id

string

Cluster ID of the pool. (UUID format)

created_at

string | null · date-time

Date on which the pool was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the pool was last updated. (RFC 3339 format)

name

string

Pool name.

status

scaleway.k8s.v1.Pool.Status · enum

Pool status.

Enum values:

unknown

ready

deleting

deleted

scaling

warning

locked

upgrading

Default: unknown

version

string

Pool version.

autoscaling

boolean

Defines whether the autoscaling feature is enabled for the pool.

min_size

integer · uint32

Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

max_size

integer · uint32

Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

container_runtime

scaleway.k8s.v1.Runtime · enum

Customization of the container runtime is available for each pool.

Enum values:

unknown_runtime

containerd

Default: unknown_runtime

autohealing

boolean

Defines whether the autohealing feature is enabled for the pool.

tags

string[]

Tags associated with the pool, see managing tagsOpen in new context.

placement_group_id

string | null

Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. (UUID format)

object

Kubelet arguments to be used by this pool. Note that this feature is experimental.

Defines how node provisioning should behave during pool version upgrade.

zone

string

Zone in which the pool's nodes will be spawned.

root_volume_type

Defines the system volume disk type. Several types of volume (volume_type) are provided:.

l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
sbs_5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
sbs_15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, use sbs_5k or sbs_15k instead.

Enum values:

default_volume_type

l_ssd

b_ssd

sbs_5k

sbs_15k

Default: default_volume_type

root_volume_size

integer | null · uint64

System volume disk size. (in bytes)

public_ip_disabled

boolean

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

security_group_id

string

Security group ID in which all the nodes of the pool will be created. If unset, the pool will use default Kapsule security group in current zone. (UUID format)

object

Kubernetes labels applied and reconciled on the nodes.

Kubernetes taints applied and reconciled on the nodes.

Kubernetes taints applied at node creation but not reconciled afterwards.

error_message

string | null

Details of the error, if any occurred when managing the pool.

max_termination_grace_period

string | null

srn

string

The SRN of the pool.

region

string

Cluster region of the pool.

PATCH/k8s/v1/regions/{region}/pools/{pool_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/k8s/v1/regions/{region}/pools/{pool_id}"

Example Request Body

{
  "autoscaling": true,
  "size": 0,
  "min_size": 0,
  "max_size": 0,
  "autohealing": true,
  "tags": [],
  "kubelet_args": {
    "<key>": "<key>"
  },
  "upgrade_policy": {
    "max_unavailable": 0,
    "max_surge": 0
  },
  "security_group_id": "security_group_id",
  "max_termination_grace_period": "2.5s"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "cluster_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "node_type": "node_type",
  "autoscaling": true,
  "size": 0,
  "min_size": 0,
  "max_size": 0,
  "container_runtime": "unknown_runtime",
  "autohealing": true,
  "tags": [
    "string"
  ],
  "placement_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "kubelet_args": {
    "<kubelet_argKey>": "<kubelet_argKey>"
  },
  "upgrade_policy": {
    "max_unavailable": 0,
    "max_surge": 0
  },
  "zone": "zone",
  "root_volume_type": "default_volume_type",
  "root_volume_size": 0,
  "public_ip_disabled": true,
  "security_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "labels": {
    "<labelKey>": "<labelKey>"
  },
  "taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "startup_taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "error_message": "error_message",
  "max_termination_grace_period": "2.5s",
  "srn": "srn",
  "region": "region"
}

json

application/json

Set a list of labels for a specific pool

PUT

https://api.scaleway.com

/k8s/v1/regions/{region}/pools/{pool_id}/set-labels

Apply a list of taints to all nodes of the pool (only apply to labels which was set through scaleway api).

Set a list of labels for a specific pool › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

pool_id

string · required

Set a list of labels for a specific pool › Request Body

object

Set a list of labels for a specific pool › Responses

200

node_type

string · required

size

integer · uint32 · required

Size (number of nodes) of the pool.

id

string

Pool ID. (UUID format)

cluster_id

string

Cluster ID of the pool. (UUID format)

created_at

string | null · date-time

Date on which the pool was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the pool was last updated. (RFC 3339 format)

name

string

Pool name.

status

scaleway.k8s.v1.Pool.Status · enum

Pool status.

Enum values:

unknown

ready

deleting

deleted

scaling

warning

locked

upgrading

Default: unknown

version

string

Pool version.

autoscaling

boolean

Defines whether the autoscaling feature is enabled for the pool.

min_size

integer · uint32

Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

max_size

integer · uint32

Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

container_runtime

scaleway.k8s.v1.Runtime · enum

Customization of the container runtime is available for each pool.

Enum values:

unknown_runtime

containerd

Default: unknown_runtime

autohealing

boolean

Defines whether the autohealing feature is enabled for the pool.

tags

string[]

Tags associated with the pool, see managing tagsOpen in new context.

placement_group_id

string | null

Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. (UUID format)

object

Kubelet arguments to be used by this pool. Note that this feature is experimental.

Defines how node provisioning should behave during pool version upgrade.

zone

string

Zone in which the pool's nodes will be spawned.

root_volume_type

Defines the system volume disk type. Several types of volume (volume_type) are provided:.

l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
sbs_5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
sbs_15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, use sbs_5k or sbs_15k instead.

Enum values:

default_volume_type

l_ssd

b_ssd

sbs_5k

sbs_15k

Default: default_volume_type

root_volume_size

integer | null · uint64

System volume disk size. (in bytes)

public_ip_disabled

boolean

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

security_group_id

string

Security group ID in which all the nodes of the pool will be created. If unset, the pool will use default Kapsule security group in current zone. (UUID format)

object

Kubernetes labels applied and reconciled on the nodes.

Kubernetes taints applied and reconciled on the nodes.

Kubernetes taints applied at node creation but not reconciled afterwards.

error_message

string | null

Details of the error, if any occurred when managing the pool.

max_termination_grace_period

string | null

srn

string

The SRN of the pool.

region

string

Cluster region of the pool.

PUT/k8s/v1/regions/{region}/pools/{pool_id}/set-labels

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"labels":{"<labelKey>":"string"}}' \
  "https://api.scaleway.com/k8s/v1/regions/{region}/pools/{pool_id}/set-labels"

Example Request Body

{
  "labels": {
    "<labelKey>": "<labelKey>"
  }
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "cluster_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "node_type": "node_type",
  "autoscaling": true,
  "size": 0,
  "min_size": 0,
  "max_size": 0,
  "container_runtime": "unknown_runtime",
  "autohealing": true,
  "tags": [
    "string"
  ],
  "placement_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "kubelet_args": {
    "<kubelet_argKey>": "<kubelet_argKey>"
  },
  "upgrade_policy": {
    "max_unavailable": 0,
    "max_surge": 0
  },
  "zone": "zone",
  "root_volume_type": "default_volume_type",
  "root_volume_size": 0,
  "public_ip_disabled": true,
  "security_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "labels": {
    "<labelKey>": "<labelKey>"
  },
  "taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "startup_taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "error_message": "error_message",
  "max_termination_grace_period": "2.5s",
  "srn": "srn",
  "region": "region"
}

json

application/json

Set a list of startup taints for a specific pool

PUT

https://api.scaleway.com

/k8s/v1/regions/{region}/pools/{pool_id}/set-startup-taints

Apply a list of taints to new nodes of the pool which would not be reconciled by scaleway.

Set a list of startup taints for a specific pool › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

pool_id

string · required

ID of the pool to update.

Set a list of startup taints for a specific pool › Request Body

List of startup taints to set.

Set a list of startup taints for a specific pool › Responses

200

node_type

string · required

size

integer · uint32 · required

Size (number of nodes) of the pool.

id

string

Pool ID. (UUID format)

cluster_id

string

Cluster ID of the pool. (UUID format)

created_at

string | null · date-time

Date on which the pool was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the pool was last updated. (RFC 3339 format)

name

string

Pool name.

status

scaleway.k8s.v1.Pool.Status · enum

Pool status.

Enum values:

unknown

ready

deleting

deleted

scaling

warning

locked

upgrading

Default: unknown

version

string

Pool version.

autoscaling

boolean

Defines whether the autoscaling feature is enabled for the pool.

min_size

integer · uint32

Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

max_size

integer · uint32

Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

container_runtime

scaleway.k8s.v1.Runtime · enum

Customization of the container runtime is available for each pool.

Enum values:

unknown_runtime

containerd

Default: unknown_runtime

autohealing

boolean

Defines whether the autohealing feature is enabled for the pool.

tags

string[]

Tags associated with the pool, see managing tagsOpen in new context.

placement_group_id

string | null

Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. (UUID format)

object

Kubelet arguments to be used by this pool. Note that this feature is experimental.

Defines how node provisioning should behave during pool version upgrade.

zone

string

Zone in which the pool's nodes will be spawned.

root_volume_type

Defines the system volume disk type. Several types of volume (volume_type) are provided:.

l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
sbs_5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
sbs_15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, use sbs_5k or sbs_15k instead.

Enum values:

default_volume_type

l_ssd

b_ssd

sbs_5k

sbs_15k

Default: default_volume_type

root_volume_size

integer | null · uint64

System volume disk size. (in bytes)

public_ip_disabled

boolean

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

security_group_id

string

Security group ID in which all the nodes of the pool will be created. If unset, the pool will use default Kapsule security group in current zone. (UUID format)

object

Kubernetes labels applied and reconciled on the nodes.

Kubernetes taints applied and reconciled on the nodes.

Kubernetes taints applied at node creation but not reconciled afterwards.

error_message

string | null

Details of the error, if any occurred when managing the pool.

max_termination_grace_period

string | null

srn

string

The SRN of the pool.

region

string

Cluster region of the pool.

PUT/k8s/v1/regions/{region}/pools/{pool_id}/set-startup-taints

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/k8s/v1/regions/{region}/pools/{pool_id}/set-startup-taints"

Example Request Body

{
  "startup_taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "cluster_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "node_type": "node_type",
  "autoscaling": true,
  "size": 0,
  "min_size": 0,
  "max_size": 0,
  "container_runtime": "unknown_runtime",
  "autohealing": true,
  "tags": [
    "string"
  ],
  "placement_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "kubelet_args": {
    "<kubelet_argKey>": "<kubelet_argKey>"
  },
  "upgrade_policy": {
    "max_unavailable": 0,
    "max_surge": 0
  },
  "zone": "zone",
  "root_volume_type": "default_volume_type",
  "root_volume_size": 0,
  "public_ip_disabled": true,
  "security_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "labels": {
    "<labelKey>": "<labelKey>"
  },
  "taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "startup_taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "error_message": "error_message",
  "max_termination_grace_period": "2.5s",
  "srn": "srn",
  "region": "region"
}

json

application/json

Set a list of taints for a specific pool

PUT

https://api.scaleway.com

/k8s/v1/regions/{region}/pools/{pool_id}/set-taints

Apply a list of taints to all nodes of the pool which will be periodically reconciled by scaleway.

Set a list of taints for a specific pool › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

pool_id

string · required

ID of the pool to update.

Set a list of taints for a specific pool › Request Body

List of taints to set.

Set a list of taints for a specific pool › Responses

200

node_type

string · required

size

integer · uint32 · required

Size (number of nodes) of the pool.

id

string

Pool ID. (UUID format)

cluster_id

string

Cluster ID of the pool. (UUID format)

created_at

string | null · date-time

Date on which the pool was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the pool was last updated. (RFC 3339 format)

name

string

Pool name.

status

scaleway.k8s.v1.Pool.Status · enum

Pool status.

Enum values:

unknown

ready

deleting

deleted

scaling

warning

locked

upgrading

Default: unknown

version

string

Pool version.

autoscaling

boolean

Defines whether the autoscaling feature is enabled for the pool.

min_size

integer · uint32

Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

max_size

integer · uint32

Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

container_runtime

scaleway.k8s.v1.Runtime · enum

Customization of the container runtime is available for each pool.

Enum values:

unknown_runtime

containerd

Default: unknown_runtime

autohealing

boolean

Defines whether the autohealing feature is enabled for the pool.

tags

string[]

Tags associated with the pool, see managing tagsOpen in new context.

placement_group_id

string | null

Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. (UUID format)

object

Kubelet arguments to be used by this pool. Note that this feature is experimental.

Defines how node provisioning should behave during pool version upgrade.

zone

string

Zone in which the pool's nodes will be spawned.

root_volume_type

Defines the system volume disk type. Several types of volume (volume_type) are provided:.

l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
sbs_5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
sbs_15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, use sbs_5k or sbs_15k instead.

Enum values:

default_volume_type

l_ssd

b_ssd

sbs_5k

sbs_15k

Default: default_volume_type

root_volume_size

integer | null · uint64

System volume disk size. (in bytes)

public_ip_disabled

boolean

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

security_group_id

string

Security group ID in which all the nodes of the pool will be created. If unset, the pool will use default Kapsule security group in current zone. (UUID format)

object

Kubernetes labels applied and reconciled on the nodes.

Kubernetes taints applied and reconciled on the nodes.

Kubernetes taints applied at node creation but not reconciled afterwards.

error_message

string | null

Details of the error, if any occurred when managing the pool.

max_termination_grace_period

string | null

srn

string

The SRN of the pool.

region

string

Cluster region of the pool.

PUT/k8s/v1/regions/{region}/pools/{pool_id}/set-taints

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/k8s/v1/regions/{region}/pools/{pool_id}/set-taints"

Example Request Body

{
  "taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "cluster_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "node_type": "node_type",
  "autoscaling": true,
  "size": 0,
  "min_size": 0,
  "max_size": 0,
  "container_runtime": "unknown_runtime",
  "autohealing": true,
  "tags": [
    "string"
  ],
  "placement_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "kubelet_args": {
    "<kubelet_argKey>": "<kubelet_argKey>"
  },
  "upgrade_policy": {
    "max_unavailable": 0,
    "max_surge": 0
  },
  "zone": "zone",
  "root_volume_type": "default_volume_type",
  "root_volume_size": 0,
  "public_ip_disabled": true,
  "security_group_id": "6170692e-7363-616c-6577-61792e636f6d",
  "labels": {
    "<labelKey>": "<labelKey>"
  },
  "taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "startup_taints": [
    {
      "key": "key",
      "value": "value",
      "effect": "NoSchedule"
    }
  ],
  "error_message": "error_message",
  "max_termination_grace_period": "2.5s",
  "srn": "srn",
  "region": "region"
}

json

application/json

Upgrade a Pool in a Cluster

POST

https://api.scaleway.com

/k8s/v1/regions/{region}/pools/{pool_id}/upgrade

Upgrade the Kubernetes version of a specific pool. Note that it only works if the targeted version matches the cluster's version. This will drain and replace the nodes in that pool.

Upgrade a Pool in a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

it-mil

pool_id

string · required

ID of the pool to upgrade.

Upgrade a Pool in a Cluster › Request Body

version

string · required

New Kubernetes version for the pool.

Upgrade a Pool in a Cluster › Responses

200

node_type

string · required

size

integer · uint32 · required

Size (number of nodes) of the pool.

id

string

Pool ID. (UUID format)

cluster_id

string

Cluster ID of the pool. (UUID format)

created_at

string | null · date-time

Date on which the pool was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the pool was last updated. (RFC 3339 format)

name

string

Pool name.

status

scaleway.k8s.v1.Pool.Status · enum

Pool status.

Enum values:

unknown

ready

deleting

deleted

scaling

warning

locked

upgrading

Default: unknown

version

string

Pool version.

autoscaling

boolean

Defines whether the autoscaling feature is enabled for the pool.

min_size

integer · uint32

Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

max_size

integer · uint32

Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

container_runtime

scaleway.k8s.v1.Runtime · enum

Customization of the container runtime is available for each pool.

Enum values:

unknown_runtime

containerd

Default: unknown_runtime

autohealing

boolean

Defines whether the autohealing feature is enabled for the pool.

tags

string[]

Tags associated with the pool, see managing tagsOpen in new context.

placement_group_id

string | null

Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. (UUID format)

object

Kubelet arguments to be used by this pool. Note that this feature is experimental.

Defines how node provisioning should behave during pool version upgrade.

zone

string

Zone in which the pool's nodes will be spawned.

root_volume_type

Defines the system volume disk type. Several types of volume (volume_type) are provided:.

l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
sbs_5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
sbs_15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, use sbs_5k or sbs_15k instead.

Enum values:

default_volume_type

l_ssd

b_ssd

sbs_5k

sbs_15k

Default: default_volume_type

root_volume_size

integer | null · uint64

System volume disk size. (in bytes)

public_ip_disabled

boolean

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

security_group_id

string

Security group ID in which all the nodes of the pool will be created. If unset, the pool will use default Kapsule security group in current zone. (UUID format)

object

Kubernetes labels applied and reconciled on the nodes.

Kubernetes taints applied and reconciled on the nodes.