Update k8s cluster pool

PATCH /cloud/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/pools/{pool_name}

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
k8s_cluster_pool = client.cloud.k8s.clusters.pools.update(
    pool_name="my-pool",
    project_id=1,
    region_id=7,
    cluster_name="my-cluster",
)
print(k8s_cluster_pool.id)

200

{
  "auto_healing_enabled": true,
  "boot_volume_size": 50,
  "boot_volume_type": "ssd_hiiops",
  "created_at": "2023-02-15T11:53:03+03:00",
  "crio_config": {
    "default-ulimits": "nofile=1024:2048"
  },
  "flavor_id": "g1-standard-1-2",
  "id": "f01fd9a0-9548-48ba-82dc-a8c8b2d6f2f1",
  "is_public_ipv4": true,
  "kubelet_config": {
    "podMaxPids": "4096"
  },
  "labels": {
    "my-label": "foo"
  },
  "max_node_count": 10,
  "min_node_count": 1,
  "name": "test",
  "node_count": 2,
  "security_group_ids": [
    "e6ea8f35-82ce-4fb2-b51c-6a24a3a23bce"
  ],
  "status": "Running",
  "taints": {
    "my-taint": "bar:NoSchedule"
  },
  "servergroup_id": "1772de21-f013-4b70-9f8f-a518985b3bc2",
  "servergroup_name": "my-server-group",
  "servergroup_policy": "anti-affinity"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

project_id · integer · required

Project ID

Example:

1

region_id · integer · required

Region ID

Example:

7

cluster_name · string · required

Cluster name

Example:

"my-cluster"

pool_name · string · required

Pool name

Example:

"my-pool"

Body

application/json

auto_healing_enabled · boolean | null

Enable/disable auto healing

Example:

true

labels · Labels · object | null

Labels applied to the cluster pool

Show child attributes

Example:

{ "my-label": "foo" }

max_node_count · integer | null

Maximum node count

Example:

3

min_node_count · integer | null

Minimum node count

Example:

1

node_count · integer | null · deprecated

This field is deprecated. Please use the cluster pool resize handler instead.

Example:

2

security_group_ids · string<uuid4>[]

Security group IDs applied to the cluster pool nodes. Omit the field to leave unchanged; pass an empty list to clear.

Example:

["e6ea8f35-82ce-4fb2-b51c-6a24a3a23bce"]

taints · Taints · object | null

Taints applied to the cluster pool

Show child attributes

Example:

{ "my-taint": "bar:NoSchedule" }

Response

200 - application/json

OK

auto_healing_enabled · boolean · required

Indicates the status of auto healing

Example:

true

boot_volume_size · integer · required

Size of the boot volume

Example:

50

boot_volume_type · string · required

Type of the boot volume

Example:

"ssd_hiiops"

created_at · string · required

Date of function creation

Example:

"2023-02-15T11:53:03+03:00"

crio_config · Crio Config · object · required

Crio configuration for pool nodes

Show child attributes

Example:

{ "default-ulimits": "nofile=1024:2048" }

flavor_id · string · required

ID of the cluster pool flavor

Example:

"g1-standard-1-2"

id · string · required

UUID of the cluster pool

Example:

"f01fd9a0-9548-48ba-82dc-a8c8b2d6f2f1"

is_public_ipv4 · boolean · required

Indicates if the pool is public

Example:

true

kubelet_config · Kubelet Config · object · required

Kubelet configuration for pool nodes

Show child attributes

Example:

{ "podMaxPids": "4096" }

labels · Labels · object · required

Labels applied to the cluster pool

Show child attributes

Example:

{ "my-label": "foo" }

max_node_count · integer · required

Maximum node count in the cluster pool

Example:

10

min_node_count · integer · required

Minimum node count in the cluster pool

Example:

1

name · string · required

Name of the cluster pool

Example:

"test"

node_count · integer · required

Node count in the cluster pool

Example:

2

security_group_ids · string[] · required

Security group IDs applied to the cluster pool nodes

Example:

["e6ea8f35-82ce-4fb2-b51c-6a24a3a23bce"]

status · string · required

Status of the cluster pool

Example:

"Running"

taints · Taints · object · required

Taints applied to the cluster pool

Show child attributes

Example:

{ "my-taint": "bar:NoSchedule" }

servergroup_id · string · default: ""

Server group ID

Example:

"1772de21-f013-4b70-9f8f-a518985b3bc2"

servergroup_name · string · default: ""

Server group name

Example:

"my-server-group"

servergroup_policy · string · default: ""

Anti-affinity, affinity or soft-anti-affinity server group policy

Example:

"anti-affinity"