This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Create Nodepool

1 - 1.4

scp-cli ske nodepool create
--pod_max_pids <value>
--max_pods <value>
--image_gc_low_threshold <value>
--image_gc_high_threshold <value>
--container_log_max_size <value>
--container_log_max_files <value>
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--linked_resources <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--scp_gpu_driver <value>]
[--server_group_id <value>]
[--taints <value>]
[--volume_max_iops <value>]
[--volume_max_throughput <value>]
[--allowed_unsafe_sysctls <value>]

Description

create a nodepool

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
pod_max_pids
required
integerPod Max PID Limit4096
max_pods
required
integerMax Pods Per Node110
image_gc_low_threshold
required
integerImage GC Low Threshold Percent80
image_gc_high_threshold
required
integerImage GC High Threshold Percent85
container_log_max_size
required
integerMax Size Of Container Log (MB)10
container_log_max_files
required
integerMax Number Of Container Log Files5
volume_type_name
required
stringVolume Type NameSSD_Provisioned
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type IDs1v1m2
name
required
stringNodepool Namesample-nodepool
kubernetes_version
required
stringKubernetes Versionv1.29.8
keypair_name
required
stringKeypair Nametest_keypair
is_auto_scale
required
booleanIs Auto Scaletrue
is_auto_recovery
required
booleanIs Auto Recoverytrue
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
stringCustom Image ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
arrayLabels'{"key": "example.com/my-app", "value": "bar"}'
linked_resources
optional
arrayList of linked resources associated with the nodepool'{"id": "res-12345678", "name": "my-resource", "type": "fs"}'
max_node_count
optional
integerMaximum node count (is_auto_scale = true)5
min_node_count
optional
integerMinimum node count (is_auto_scale = true)1
scp_gpu_driver
optional
stringGPU Driver Version-
server_group_id
optional
stringServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
taints
optional
arrayTaints'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'
volume_max_iops
optional
integerVolume Max Iops5000
volume_max_throughput
optional
integerVolume Max Throughput250
allowed_unsafe_sysctls
optional
stringAllowed Unsafe sysctlskernel.msg*,net.ipv4.route.min_pmtu

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settingsAdvanced Settings
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsLabels
linked_resourcesList of linked resources associated with the nodepool
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_group_idServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_typeServer Type
statusNode Pool StatusRunning
taintsTaints
volume_max_iopsVolume Max Iops5000
volume_max_throughputVolume Max Throughput250
volume_sizeVolume Size104
volume_typeVolume Type

2 - 1.3

scp-cli ske nodepool create
--pod_max_pids <value>
--max_pods <value>
--image_gc_low_threshold <value>
--image_gc_high_threshold <value>
--container_log_max_size <value>
--container_log_max_files <value>
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--linked_resources <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--server_group_id <value>]
[--taints <value>]
[--allowed_unsafe_sysctls <value>]

Description

create a nodepool

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261121

Parameters

NameTypeDescriptionExample
pod_max_pids
required
integerPod Max PID Limit4096
max_pods
required
integerMax Pods Per Node110
image_gc_low_threshold
required
integerImage GC Low Threshold Percent80
image_gc_high_threshold
required
integerImage GC High Threshold Percent85
container_log_max_size
required
integerMax Size Of Container Log (MB)10
container_log_max_files
required
integerMax Number Of Container Log Files5
volume_type_name
required
stringVolume Type NameSSD_Provisioned
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type IDs1v1m2
name
required
stringNodepool Namesample-nodepool
kubernetes_version
required
stringKubernetes Versionv1.29.8
keypair_name
required
stringKeypair Nametest_keypair
is_auto_scale
required
booleanIs Auto Scaletrue
is_auto_recovery
required
booleanIs Auto Recoverytrue
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
stringCustom Image ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
arrayLabels'{"key": "example.com/my-app", "value": "bar"}'
linked_resources
optional
arrayList of linked resources associated with the nodepool'{"id": "res-12345678", "name": "my-resource", "type": "fs"}'
max_node_count
optional
integerMaximum node count (is_auto_scale = true)5
min_node_count
optional
integerMinimum node count (is_auto_scale = true)1
server_group_id
optional
stringServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
taints
optional
arrayTaints'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'
allowed_unsafe_sysctls
optional
stringAllowed Unsafe sysctlskernel.msg*,net.ipv4.route.min_pmtu

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settingsAdvanced Settings
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsLabels
linked_resourcesList of linked resources associated with the nodepool
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_group_idServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_typeServer Type
statusNode Pool StatusRunning
taintsTaints
volume_sizeVolume Size104
volume_typeVolume Type

3 - 1.2

scp-cli ske nodepool create
--pod_max_pids <value>
--max_pods <value>
--image_gc_low_threshold <value>
--image_gc_high_threshold <value>
--container_log_max_size <value>
--container_log_max_files <value>
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--server_group_id <value>]
[--taints <value>]
[--allowed_unsafe_sysctls <value>]

Description

create a nodepool v1.1

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261021

Parameters

NameTypeDescriptionExample
pod_max_pids
required
integerPod Max PID Limit4096
max_pods
required
integerMax Pods Per Node110
image_gc_low_threshold
required
integerImage GC Low Threshold Percent80
image_gc_high_threshold
required
integerImage GC High Threshold Percent85
container_log_max_size
required
integerMax Size Of Container Log (MB)10
container_log_max_files
required
integerMax Number Of Container Log Files5
volume_type_name
required
stringVolume Type NameSSD_Provisioned
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type IDs1v1m2
name
required
stringNodepool Namesample-nodepool
kubernetes_version
required
stringKubernetes Versionv1.29.8
keypair_name
required
stringKeypair Nametest_keypair
is_auto_scale
required
booleanIs Auto Scaletrue
is_auto_recovery
required
booleanIs Auto Recoverytrue
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
stringCustom Image ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
arrayLabels'{"key": "example.com/my-app", "value": "bar"}'
max_node_count
optional
integerMaximum node count (is_auto_scale = true)5
min_node_count
optional
integerMinimum node count (is_auto_scale = true)1
server_group_id
optional
stringServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
taints
optional
arrayTaints'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'
allowed_unsafe_sysctls
optional
stringAllowed Unsafe sysctlskernel.msg*,net.ipv4.route.min_pmtu

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settingsAdvanced Settings
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsLabels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_group_idServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_typeServer Type
statusNode Pool StatusRunning
taintsTaints
volume_sizeVolume Size104
volume_typeVolume Type

4 - 1.1

scp-cli ske nodepool create
--pod_max_pids <value>
--max_pods <value>
--image_gc_low_threshold <value>
--image_gc_high_threshold <value>
--container_log_max_size <value>
--container_log_max_files <value>
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--server_group_id <value>]
[--taints <value>]
[--allowed_unsafe_sysctls <value>]

Description

create a nodepool v1.1

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260919

Parameters

NameTypeDescriptionExample
pod_max_pids
required
integerPod Max PID Limit4096
max_pods
required
integerMax Pods Per Node110
image_gc_low_threshold
required
integerImage GC Low Threshold Percent80
image_gc_high_threshold
required
integerImage GC High Threshold Percent85
container_log_max_size
required
integerMax Size Of Container Log (MB)10
container_log_max_files
required
integerMax Number Of Container Log Files5
volume_type_name
required
stringVolume Type NameSSD_Provisioned
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type IDs1v1m2
name
required
stringNodepool Namesample-nodepool
kubernetes_version
required
stringKubernetes Versionv1.29.8
keypair_name
required
stringKeypair Nametest_keypair
is_auto_scale
required
booleanIs Auto Scaletrue
is_auto_recovery
required
booleanIs Auto Recoverytrue
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
stringCustom Image ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
arrayLabels'{"key": "example.com/my-app", "value": "bar"}'
max_node_count
optional
integerMaximum node count (is_auto_scale = true)5
min_node_count
optional
integerMinimum node count (is_auto_scale = true)1
server_group_id
optional
stringServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
taints
optional
arrayTaints'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'
allowed_unsafe_sysctls
optional
stringAllowed Unsafe sysctlskernel.msg*,net.ipv4.route.min_pmtu

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
advanced_settingsAdvanced Settings
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsLabels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_group_idServer Group ID2b8d33d5-4de5-40a5-a34c-7e30204133xc
server_typeServer Type
statusNode Pool StatusRunning
taintsTaints
volume_sizeVolume Size104
volume_typeVolume Type

5 - 1.0

scp-cli ske nodepool create
--volume_type_name <value>
--volume_size <value>
--server_type_id <value>
--name <value>
--kubernetes_version <value>
--keypair_name <value>
--is_auto_scale <value>
--is_auto_recovery <value>
--image_os_version <value>
--image_os <value>
--cluster_id <value>
[--custom_image_id <value>]
[--desired_node_count <value>]
[--labels <value>]
[--max_node_count <value>]
[--min_node_count <value>]
[--taints <value>]

Description

create a nodepool v1.0

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_type_name
required
stringVolume Type NameSSD_Provisioned
volume_size
required
integerVolume Size104
server_type_id
required
stringServer Type IDs1v1m2
name
required
stringNodepool Namesample-nodepool
kubernetes_version
required
stringKubernetes Versionv1.29.8
keypair_name
required
stringKeypair Nametest_keypair
is_auto_scale
required
booleanIs Auto Scaletrue
is_auto_recovery
required
booleanIs Auto Recoverytrue
image_os_version
required
stringImage OS Version22.04
image_os
required
stringImage OSubuntu
cluster_id
required
stringCluster ID70a599e031e749b7b260868f441e862b
custom_image_id
optional
stringCustom Image ID10a599e031e749b7b260868f441e862b
desired_node_count
optional
integerDesired node count (is_auto_scale = false)2
labels
optional
arrayLabels'{"key": "example.com/my-app", "value": "bar"}'
max_node_count
optional
integerMaximum node count (is_auto_scale = true)5
min_node_count
optional
integerMinimum node count (is_auto_scale = true)1
taints
optional
arrayTaints'{"effect": "NoSchedule", "key": "example.com/my-app", "value": "bar"}'

Responses

NameDescriptionExample
idNodepool IDbdfda539-bd2e-4a5c-9021-ec6d52d1ca79
account_idAccount ID617b3d0e90c24a5fa1f65a3824861354
auto_recovery_enabledIs Auto Recoverytrue
auto_scale_enabledIs Auto Scaletrue
clusterCluster
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
current_node_countCurrent Node Count1
desired_node_countDesired Node Count2
imageImage
keypairKeypair Name
kubernetes_versionKubernetes Versionv1.29.8
labelsLabels
max_node_countMax Node Count5
min_node_countMin Node Count1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNodepool Namesample-nodepool
server_typeServer Type
statusNode Pool StatusRunning
taintsTaints
volume_sizeVolume Size104
volume_typeVolume Type