Documentation | Managed Kubernetes › Clusters

Managed Kubernetes

managed_kubernetes

Methods

List Available K8s Cluster Versions For Cluster Creation ->

K8sClusterVersionList

get/v2/k8s/{project_id}/{region_id}/create_versions

List available k8s cluster versions for cluster creation

List Flavors -> { count, results }

get/v1/k8s/{project_id}/{region_id}/flavors

Retrieve a list of flavors for k8s pool. When the include_prices query parameter is specified, the list shows prices. A client in trial mode gets all price values as 0. If you get Pricing Error contact the support

Domain types

K8sClusterVersionList = { count, results }

Managed Kubernetes

Clusters

managed_kubernetes.clusters

Methods

Check Quota For Cluster Creation -> { baremetal_basic_count_limit, baremetal_basic_count_requested, baremetal_basic_count_usage, 126 more... }

post/v2/k8s/clusters/{project_id}/{region_id}/check_limits

Check if regional quota is exceeded, if yes the number of additional quotas needed to create the specified cluster will be calculated

Create K8s Cluster -> { tasks }

post/v2/k8s/clusters/{project_id}/{region_id}

Create k8s cluster

Delete K8s Cluster -> { tasks }

delete/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}

Delete k8s cluster

Get K8s Cluster Ca Certificate -> { certificate, key }

get/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/certificates

Get k8s cluster CA certificate

Get K8s Cluster Kubeconfig -> { config, created_at, expires_at }

get/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/config

Get k8s cluster kubeconfig

List K8s Clusters -> { count, results }

get/v2/k8s/clusters/{project_id}/{region_id}

List k8s clusters

List Instances In K8s Cluster -> { count, results }

get/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/instances

List instances in k8s cluster

List Available K8s Cluster Versions For Upgrade ->

K8sClusterVersionList

get/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/upgrade_versions

List available k8s cluster versions for upgrade

Get K8s Cluster -> { id, created_at, is_public, 19 more... }

get/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}

Get k8s cluster

Parameters

project_id: number

region_id: number

cluster_name: string

Response fields

id: string

Cluster pool uuid

created_at: string

Function creation date

is_public: boolean

Cluster is public

keypair: string

Keypair

name: string

Name

pools: Array<

K8sClusterPool

pools

status: "Deleting" | "Provisioned" | "Provisioning"

Status

version: string

K8s version

authentication: { kubeconfig_created_at, kubeconfig_expires_at, oidc }

Optional

Cluster authentication settings

autoscaler_config: Record<string, string>

Optional

Cluster autoscaler configuration params

cni: { cilium, provider }

Optional

Cluster CNI settings

creator_task_id: string

Optional

Task that created this entity

ddos_profile: { enabled, fields, profile_template, 1 more... }

Optional

Advanced DDoS Protection profile

fixed_network: string

Optional

Fixed network id

fixed_subnet: string

Optional

Fixed subnet id

is_ipv6: boolean

Optional

Enable public v6 address

logging: { destination_region_id, enabled, retention_policy, 1 more... }

Optional

Logging configuration

pods_ip_pool: string

Optional

The IP pool for the pods

pods_ipv6_pool: string

Optional

The IPv6 pool for the pods

services_ip_pool: string

Optional

The IP pool for the services

services_ipv6_pool: string

Optional

The IPv6 pool for the services

task_id: string

Optional

Active task

Request example

curl https://api.gcore.com/cloud/v2/k8s/clusters/$PROJECT_ID/$REGION_ID/$CLUSTER_NAME \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "id": "f01fd9a0-9548-48ba-82dc-a8c8b2d6f2f1",
  "created_at": "2023-02-15T11:53:03Z",
  "is_public": false,
  "keypair": "mykeypair",
  "name": "test k8s",
  "pools": [
    {
      "id": "f01fd9a0-9548-48ba-82dc-a8c8b2d6f2f1",
      "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",
      "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,
      "status": "Running",
      "taints": {
        "my-taint": "bar:NoSchedule"
      },
      "servergroup_id": "1772de21-f013-4b70-9f8f-a518985b3bc2",
      "servergroup_name": "my-server-group",
      "servergroup_policy": "anti-affinity"
    }
  ],
  "status": "Deleting",
  "version": "v1.28.1",
  "authentication": {
    "kubeconfig_created_at": "2024-02-15T11:53:03Z",
    "kubeconfig_expires_at": "2026-02-15T11:53:03Z",
    "oidc": {
      "client_id": "kubernetes",
      "groups_claim": "groups",
      "groups_prefix": "oidc:",
      "issuer_url": "https://accounts.provider.example",
      "required_claims": {
        "claim": "value"
      },
      "signing_algs": [
        "ES256",
        "ES384"
      ],
      "username_claim": "sub",
      "username_prefix": "oidc:"
    }
  },
  "autoscaler_config": {
    "scale-down-unneeded-time": "5m"
  },
  "cni": {
    "cilium": {
      "encryption": true,
      "hubble_relay": true,
      "hubble_ui": true,
      "lb_acceleration": true,
      "lb_mode": "dsr",
      "mask_size": 24,
      "mask_size_v6": 120,
      "routing_mode": "native",
      "tunnel": ""
    },
    "provider": "calico"
  },
  "creator_task_id": "1772de21-f013-4b70-9f8f-a518985b3bc2",
  "ddos_profile": {
    "enabled": true,
    "fields": [
      {
        "base_field": 10,
        "field_value": [
          45046,
          45047
        ],
        "value": "value"
      }
    ],
    "profile_template": 29,
    "profile_template_name": "profile_template_name"
  },
  "fixed_network": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fixed_subnet": "90729bc3-dd37-4761-ae09-b32f2f0a365b",
  "is_ipv6": true,
  "logging": {
    "destination_region_id": 1,
    "enabled": true,
    "retention_policy": {
      "period": 45
    },
    "topic_name": "some-topic"
  },
  "pods_ip_pool": "172.16.0.0/18",
  "pods_ipv6_pool": "2a03:90c0:88:393::/64",
  "services_ip_pool": "172.24.0.0/18",
  "services_ipv6_pool": "2a03:90c0:88:381::/108",
  "task_id": "task_id"
}

Update K8s Cluster -> { tasks }

patch/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}

Update k8s cluster

Upgrade K8s Cluster -> { tasks }

post/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/upgrade

Upgrade k8s cluster

Managed Kubernetes Clusters

Pools

managed_kubernetes.clusters.pools

Methods

Create K8s Cluster Pool -> { tasks }

post/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/pools

Create k8s cluster pool

Delete K8s Cluster Pool -> { tasks }

delete/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/pools/{pool_name}

Delete k8s cluster pool

List K8s Cluster Pools -> { count, results }

get/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/pools

List k8s cluster pools

List Instances In K8s Cluster Pool -> { count, results }

get/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/pools/{pool_name}/instances

List instances in k8s cluster pool

Resize K8s Cluster Pool -> { tasks }

post/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/pools/{pool_name}/resize

Resize k8s cluster pool

Get K8s Cluster Pool Details ->

K8sClusterPool

get/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/pools/{pool_name}

Get k8s cluster pool details

Update K8s Cluster Pool ->

K8sClusterPool

patch/v2/k8s/clusters/{project_id}/{region_id}/{cluster_name}/pools/{pool_name}

Update k8s cluster pool

Domain types

K8sClusterPool = { id, auto_healing_enabled, boot_volume_size, 16 more... }