Cluster API

​

read_cluster

1
vessl.read_cluster(
2
cluster_name: str, **kwargs
3
)
Copied!
Read cluster in the default organization. If you want to override the default organization, then pass organization_name as **kwargs.
Args
  • cluster_name (str) : Cluster name.
Example
1
vessl.read_cluster(
2
cluster_name="seoul-cluster",
3
)
Copied!
​

list_clusters

1
vessl.list_clusters(
2
**kwargs
3
)
Copied!
List clusters in the default organization. If you want to override the default organization, then pass organization_name as **kwargs.
Example
1
vessl.list_clusters()
Copied!
​

delete_cluster

1
vessl.delete_cluster(
2
cluster_id: int, **kwargs
3
)
Copied!
Delete custom cluster in the default organization. If you want to override the default organization, then pass organization_name as **kwargs.
Args
  • cluster_id (int) : Cluster ID.
Example
1
vessl.delete_cluster(
2
cluster_id=1,
3
)
Copied!
​

rename_cluster

1
vessl.rename_cluster(
2
cluster_id: int, new_cluster_name: str, **kwargs
3
)
Copied!
Rename custom cluster in the default organization. If you want to override the default organization, then pass organization_name as **kwargs.
Args
  • cluster_id (int) : Cluster ID.
  • new_cluster_name (str) : Cluster name to change.
Example
1
vessl.rename_cluster(
2
cluster_id=1,
3
new_cluster_name="seoul-cluster-2",
4
)
Copied!
​

list_cluster_nodes

1
vessl.list_cluster_nodes(
2
cluster_id: int, **kwargs
3
)
Copied!
List custom cluster nodes in the default organization. If you want to override the default organization, then pass organization_name as **kwargs.
Args
  • cluster_id (int) : Cluster ID.
Example
1
vessl.list_cluster_nodes(
2
cluster_id=1,
3
)
Copied!