Create k8s cluster

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 identifier

region_id

integer

required

Region identifier

Body

application/json

keypair

string

required

The keypair of the cluster

Required string length: 1 - 255

name

string

required

The name of the cluster

Required string length: 1 - 20

pools

K8sClusterPoolCreateV2Serializer · object[]

required

The pools of the cluster

Minimum array length: 1

Show child attributes

pools.flavor_id

string

required

Flavor ID

pools.min_node_count

integer

required

Minimum node count

Required range: 1 <= x <= 200

pools.name

string

required

Pool's name

Required string length: 1 - 20

pools.auto_healing_enabled

boolean | null

default:false

Enable auto healing

Example:

true

pools.boot_volume_size

integer | null

Boot volume size

Required range: 10 <= x <= 2000

Example:

50

pools.boot_volume_type

enum<string> | null

Boot volume type

Available options:

cold,

ssd_hiiops,

ssd_local,

ssd_lowlatency,

standard,

ultra

Example:

"ssd_hiiops"

pools.crio_config

Crio Config · object

Cri-o configuration for pool nodes

Show child attributes

pools.crio_config.{key}

string

Example:

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

pools.is_public_ipv4

boolean | null

default:false

Enable public v4 address

Example:

true

pools.kubelet_config

Kubelet Config · object

Kubelet configuration for pool nodes

Show child attributes

pools.kubelet_config.{key}

string

Example:

{ "podMaxPids": "4096" }

pools.labels

Labels · object

Labels applied to the cluster pool

Show child attributes

pools.labels.{key}

string

Example:

{ "my-label": "foo" }

pools.max_node_count

integer | null

Maximum node count

Required range: 1 <= x <= 200

Example:

5

pools.servergroup_policy

enum<string> | null

Server group policy: anti-affinity, soft-anti-affinity or affinity

Available options:

affinity,

anti-affinity,

soft-anti-affinity

pools.taints

Taints · object

Taints applied to the cluster pool

Show child attributes

pools.taints.{key}

string

Example:

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

version

string

required

The version of the k8s cluster

add_ons

K8sClusterAddonsCreateV2Serializer · object

Cluster add-ons configuration

Show child attributes

add_ons.slurm

K8sClusterSlurmAddonEnableV2Serializer · object

Slurm add-on configuration

Show child attributes

add_ons.slurm.enabled

enum<boolean>

required

The Slurm add-on will be enabled in the cluster.

This add-on is only supported in clusters running Kubernetes v1.31 and v1.32 with at least 1 GPU cluster pool and VAST NFS support enabled.

Available options:

true,

false

ID of a VAST file share to be used as Slurm storage.

The Slurm add-on will create separate Persistent Volume Claims for different purposes (controller spool, worker spool, jail) on that file share.

The file share must have root_squash disabled, while path_length and allowed_characters settings must be set to NPL.

add_ons.slurm.ssh_key_ids

string<uuid4>[]

required

IDs of SSH keys to authorize for SSH connection to Slurm login nodes.

Minimum array length: 1

add_ons.slurm.worker_count

integer

required

Size of the worker pool, i.e. the number of Slurm worker nodes.

Each Slurm worker node will be backed by a Pod scheduled on one of cluster's GPU nodes.

Required range: x >= 1

authentication

K8sClusterAuthenticationCreateV2Serializer · object

Authentication settings

Show child attributes

authentication.oidc

K8sClusterOIDCV2Serializer · object

OIDC authentication settings

Show child attributes

authentication.oidc.client_id

string | null

Client ID

Example:

"kubernetes"

authentication.oidc.groups_claim

string | null

JWT claim to use as the user's group

Example:

"groups"

authentication.oidc.groups_prefix

string | null

Prefix prepended to group claims

Example:

"oidc:"

authentication.oidc.issuer_url

string | null

Issuer URL

Example:

"https://accounts.provider.example"

authentication.oidc.required_claims

Required Claims · object

Key-value pairs that describe required claims in the token

Show child attributes

authentication.oidc.required_claims.{key}

string

Example:

{ "claim": "value" }

authentication.oidc.signing_algs

enum<string>[] | null

Accepted signing algorithms

Available options:

ES256,

ES384,

ES512,

PS256,

PS384,

PS512,

RS256,

RS384,

RS512

Example:

["RS512"]

authentication.oidc.username_claim

string | null

JWT claim to use as the user name

Example:

"sub"

authentication.oidc.username_prefix

string | null

Prefix prepended to username claims to prevent clashes

Example:

"oidc:"

Example:

{
  "oidc": {
    "client_id": "kubernetes",
    "groups_claim": "groups",
    "groups_prefix": "oidc:",
    "issuer_url": "https://accounts.provider.example",
    "required_claims": { "claim": "value" },
    "signing_algs": ["RS256", "RS512"],
    "username_claim": "sub",
    "username_prefix": "oidc:"
  }
}

autoscaler_config

Autoscaler Config · object

Cluster autoscaler configuration.

It allows you to override the default cluster-autoscaler parameters provided by the platform with your preferred values.

Supported parameters (in alphabetical order):

balance-similar-node-groups (boolean: true/false) - Detect similar node groups and balance the number of nodes between them.
expander (string: random, most-pods, least-waste, price, priority, grpc) - Type of node group expander to be used in scale up. Specifying multiple values separated by commas will call the expanders in succession until there is only one option remaining.
expendable-pods-priority-cutoff (float) - Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they don't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.
ignore-daemonsets-utilization (boolean: true/false) - Should CA ignore DaemonSet pods when calculating resource utilization for scaling down.
max-empty-bulk-delete (integer) - Maximum number of empty nodes that can be deleted at the same time.
max-graceful-termination-sec (integer) - Maximum number of seconds CA waits for pod termination when trying to scale down a node.
max-node-provision-time (duration: e.g., '15m') - The default maximum time CA waits for node to be provisioned - the value can be overridden per node group.
max-total-unready-percentage (float) - Maximum percentage of unready nodes in the cluster. After this is exceeded, CA halts operations.
new-pod-scale-up-delay (duration: e.g., '10s') - Pods less than this old will not be considered for scale-up. Can be increased for individual pods through annotation.
ok-total-unready-count (integer) - Number of allowed unready nodes, irrespective of max-total-unready-percentage.
scale-down-delay-after-add (duration: e.g., '10m') - How long after scale up that scale down evaluation resumes.
scale-down-delay-after-delete (duration: e.g., '10s') - How long after node deletion that scale down evaluation resumes.
scale-down-delay-after-failure (duration: e.g., '3m') - How long after scale down failure that scale down evaluation resumes.
scale-down-enabled (boolean: true/false) - Should CA scale down the cluster.
scale-down-unneeded-time (duration: e.g., '10m') - How long a node should be unneeded before it is eligible for scale down.
scale-down-unready-time (duration: e.g., '20m') - How long an unready node should be unneeded before it is eligible for scale down.
scale-down-utilization-threshold (float) - The maximum value between the sum of cpu requests and sum of memory requests of all pods running on the node divided by node's corresponding allocatable resource, below which a node can be considered for scale down.
scan-interval (duration: e.g., '10s') - How often cluster is reevaluated for scale up or down.
skip-nodes-with-custom-controller-pods (boolean: true/false) - If true cluster autoscaler will never delete nodes with pods owned by custom controllers.
skip-nodes-with-local-storage (boolean: true/false) - If true cluster autoscaler will never delete nodes with pods with local storage, e.g. EmptyDir or HostPath.
skip-nodes-with-system-pods (boolean: true/false) - If true cluster autoscaler will never delete nodes with pods from kube-system (except for DaemonSet or mirror pods).

Show child attributes

autoscaler_config.{key}

string

Example:

{ "scale-down-unneeded-time": "5m" }

cni

K8sClusterCNICreateV2Serializer · object

Cluster CNI settings

Show child attributes

cni.cilium

K8sClusterCiliumV2Serializer · object

Cilium settings

Show child attributes

cni.cilium.encryption

boolean

default:false

Wireguard encryption

cni.cilium.hubble_relay

boolean

default:false

Hubble Relay

cni.cilium.hubble_ui

boolean

default:false

Hubble UI

cni.cilium.lb_acceleration

boolean

default:false

LoadBalancer acceleration

cni.cilium.lb_mode

enum<string>

default:snat

LoadBalancer mode

Available options:

dsr,

hybrid,

snat

cni.cilium.mask_size

integer

default:24

Mask size for IPv4

cni.cilium.mask_size_v6

integer

default:120

Mask size for IPv6

cni.cilium.routing_mode

enum<string>

default:tunnel

Routing mode

Available options:

native,

tunnel

cni.cilium.tunnel

enum<string>

default:geneve

CNI provider

Available options:

geneve,

vxlan

cni.provider

enum<string>

default:calico

CNI provider

Available options:

calico,

cilium

Example:

{
  "cilium": {
    "encryption": true,
    "hubble_relay": true,
    "hubble_ui": true,
    "lb_acceleration": true,
    "lb_mode": "snat",
    "tunnel": "geneve"
  },
  "provider": "cilium"
}

csi

K8sClusterCSICreateV2Serializer · object

Container Storage Interface (CSI) driver settings

Show child attributes

csi.nfs

K8sClusterNFSCreateV2Serializer · object

NFS CSI driver settings

Show child attributes

csi.nfs.vast_enabled

boolean

default:false

Enable or disable VAST NFS integration. The default value is false. When set to true, a dedicated StorageClass will be created in the cluster for each VAST NFS file share defined in the cloud. All file shares created prior to cluster creation will be available immediately, while those created afterward may take a few minutes for to appear.

ddos_profile

K8sClusterDdosProfileCreateV2Serializer · object

Advanced DDoS Protection profile

Show child attributes

ddos_profile.enabled

boolean

required

Enable advanced DDoS protection

ddos_profile.fields

K8sClusterDdosProfileFieldV2Serializer · object[]

DDoS profile parameters

Show child attributes

ddos_profile.fields.base_field

integer

required

ddos_profile.fields.field_value

any | null

Complex value. Only one of 'value' or 'field_value' must be specified

Example:

[45046, 45047]

ddos_profile.fields.value

string | null

Basic value. Only one of 'value' or 'field_value' must be specified

Maximum string length: 500

Example:

null

ddos_profile.profile_template

integer | null

DDoS profile template ID

Example:

29

ddos_profile.profile_template_name

string | null

DDoS profile template name

Example:

{
  "enabled": true,
  "fields": [
    {
      "base_field": 10,
      "field_value": [45046, 45047]
    }
  ],
  "profile_template": 29
}

fixed_network

string | null

default:""

The network of the cluster

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

fixed_subnet

string | null

default:""

The subnet of the cluster

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

is_ipv6

boolean | null

default:false

Enable public v6 address

Example:

true

logging

K8sClusterLoggingCreateV2Serializer · object

Logging configuration

Show child attributes

logging.destination_region_id

integer | null

Destination region id to which the logs will be written

Example:

1

logging.enabled

boolean

default:false

Enable/disable forwarding logs to LaaS

logging.retention_policy

LaasIndexRetentionPolicyPydanticSerializer · object

The logs retention policy

Show child attributes

logging.retention_policy.period

integer | null

required

Duration of days for which logs must be kept.

Required range: 0 < x <= 1825

Example:

45

Example:

{ "period": 45 }

logging.topic_name

string | null

The topic name to which the logs will be written

Required string length: 1 - 223

Example:

"my-log-name"

Example:

{
  "destination_region_id": 1,
  "enabled": true,
  "retention_policy": { "period": 45 },
  "topic_name": "my-log-name"
}

pods_ip_pool

string | null

The IP pool for the pods

Example:

"172.16.0.0/18"

pods_ipv6_pool

string | null

The IPv6 pool for the pods

Example:

"2a03:90c0:88:393::/64"

services_ip_pool

string | null

The IP pool for the services

Example:

"172.24.0.0/18"

services_ipv6_pool

string | null

The IPv6 pool for the services

Example:

"2a03:90c0:88:381::/108"

Response

Task IDs for cluster creation

tasks

string[]

required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Authorizations

Path Parameters

Body

Response