JavaScript SDK

Kubernetes

Kubernetes clusters and templates

12 methods

GET

listKubernetesClusters()

List Kubernetes clusters

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

status

string

- Filter by cluster status

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.listKubernetesClusters();
console.log(result);

POST

createKubernetesCluster()

Create Kubernetes cluster

Parameters

name

string

required

cluster_template_id

string

required

keypair

string

- SSH keypair name

docker_volume_size

integer

- Docker volume size in GB

labels

object

master_flavor_id

string

flavor_id

string

master_count

integer

node_count

integer

create_timeout

integer

fixed_network

string

fixed_subnet

string

floating_ip_enabled

boolean

master_lb_enabled

boolean

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.createKubernetesCluster({
  name: "production-cluster",
  cluster_template_id: "550e8400-e29b-41d4-a716-446655440000"
});
console.log(result);

GET

getKubernetesCluster()

Get Kubernetes cluster

Parameters

cluster_id

string

required

- Kubernetes Cluster ID

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.getKubernetesCluster({
  cluster_id: "550e8400-e29b-41d4-a716-446655440000"
});
console.log(result);

PATCH

updateKubernetesCluster()

Update Kubernetes cluster

Parameters

cluster_id

string

required

- Kubernetes Cluster ID

node_count

integer

- New worker node count (for scaling)

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.updateKubernetesCluster({
  cluster_id: "550e8400-e29b-41d4-a716-446655440000"
});
console.log(result);

DELETE

deleteKubernetesCluster()

Delete Kubernetes cluster

Parameters

cluster_id

string

required

- Kubernetes Cluster ID

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.deleteKubernetesCluster({
  cluster_id: "550e8400-e29b-41d4-a716-446655440000"
});
console.log(result);

GET

getKubernetesClusterKubeconfig()

Get cluster kubeconfig

Parameters

cluster_id

string

required

- Kubernetes Cluster ID

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.getKubernetesClusterKubeconfig({
  cluster_id: "550e8400-e29b-41d4-a716-446655440000"
});
console.log(result);

POST

resizeKubernetesCluster()

Resize Kubernetes cluster

Parameters

cluster_id

string

required

- Kubernetes Cluster ID

node_count

integer

required

- New worker node count

nodes_to_remove

array

- Specific nodes to remove (by name)

nodegroup

string

- Node group to resize

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.resizeKubernetesCluster({
  cluster_id: "550e8400-e29b-41d4-a716-446655440000",
  node_count: 10
});
console.log(result);

GET

listKubernetesTemplates()

List cluster templates

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

coe

string

- Filter by container orchestration engine

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.listKubernetesTemplates();
console.log(result);

POST

createKubernetesTemplate()

Create cluster template

Parameters

name

string

required

coe

string

required

image_id

string

required

keypair_id

string

external_network_id

string

required

fixed_network

string

fixed_subnet

string

dns_nameserver

string

docker_storage_driver

string

docker_volume_size

integer

volume_driver

string

network_driver

string

http_proxy

string

https_proxy

string

no_proxy

string

labels

object

master_flavor_id

string

flavor_id

string

server_type

string

registry_enabled

boolean

insecure_registry

string

floating_ip_enabled

boolean

master_lb_enabled

boolean

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.createKubernetesTemplate({
  name: "example-string",
  coe: "kubernetes",
  image_id: "550e8400-e29b-41d4-a716-446655440000",
  external_network_id: "550e8400-e29b-41d4-a716-446655440000"
});
console.log(result);

GET

getKubernetesTemplate()

Get cluster template

Parameters

cluster_template_id

string

required

- Kubernetes Cluster Template ID

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.getKubernetesTemplate({
  cluster_template_id: "550e8400-e29b-41d4-a716-446655440000"
});
console.log(result);

PATCH

updateKubernetesTemplate()

Update cluster template

Parameters

cluster_template_id

string

required

- Kubernetes Cluster Template ID

name

string

labels

object

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.updateKubernetesTemplate({
  cluster_template_id: "550e8400-e29b-41d4-a716-446655440000"
});
console.log(result);

DELETE

deleteKubernetesTemplate()

Delete cluster template

Parameters

cluster_template_id

string

required

- Kubernetes Cluster Template ID

Example

import { ByCloud } from "@bycoded/bycloud-sdk";

const client = new ByCloud({
  token: "YOUR_ACCESS_TOKEN",
});

const result = await client.kubernetes.deleteKubernetesTemplate({
  cluster_template_id: "550e8400-e29b-41d4-a716-446655440000"
});
console.log(result);