Python SDK

Kubernetes

Kubernetes clusters and templates

12 methods

GET

list_kubernetes_clusters()

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

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.list_kubernetes_clusters()
print(result)

POST

create_kubernetes_cluster()

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

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.create_kubernetes_cluster(name="production-cluster", cluster_template_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

GET

get_kubernetes_cluster()

Get Kubernetes cluster

Parameters

cluster_id

string

required

- Kubernetes Cluster ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.get_kubernetes_cluster(cluster_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

PATCH

update_kubernetes_cluster()

Update Kubernetes cluster

Parameters

cluster_id

string

required

- Kubernetes Cluster ID

node_count

integer

- New worker node count (for scaling)

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.update_kubernetes_cluster(cluster_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

DELETE

delete_kubernetes_cluster()

Delete Kubernetes cluster

Parameters

cluster_id

string

required

- Kubernetes Cluster ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.delete_kubernetes_cluster(cluster_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

GET

get_kubernetes_cluster_kubeconfig()

Get cluster kubeconfig

Parameters

cluster_id

string

required

- Kubernetes Cluster ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.get_kubernetes_cluster_kubeconfig(cluster_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

POST

resize_kubernetes_cluster()

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

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.resize_kubernetes_cluster(cluster_id="550e8400-e29b-41d4-a716-446655440000", node_count=10)
print(result)

GET

list_kubernetes_templates()

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

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.list_kubernetes_templates()
print(result)

POST

create_kubernetes_template()

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

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.create_kubernetes_template(name="example-string", coe="kubernetes", image_id="550e8400-e29b-41d4-a716-446655440000", external_network_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

GET

get_kubernetes_template()

Get cluster template

Parameters

cluster_template_id

string

required

- Kubernetes Cluster Template ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.get_kubernetes_template(cluster_template_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

PATCH

update_kubernetes_template()

Update cluster template

Parameters

cluster_template_id

string

required

- Kubernetes Cluster Template ID

name

string

labels

object

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.update_kubernetes_template(cluster_template_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

DELETE

delete_kubernetes_template()

Delete cluster template

Parameters

cluster_template_id

string

required

- Kubernetes Cluster Template ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.kubernetes.delete_kubernetes_template(cluster_template_id="550e8400-e29b-41d4-a716-446655440000")
print(result)