Comment on page
Cluster API
vessl.create_cluster(
param: CreateClusterParam
)
Create a VESSL cluster by installing VESSL agent to given Kubernetes namespace. If you want to override the default organization, then pass
organization_name to param.Args
param(CreateClusterParam) : Create cluster parameter.
Example
vessl.install_cluster(
param=vessl.CreateClusterParam(
cluster_name="foo",
...
),
)
vessl.read_cluster(
cluster_name: str, **kwargs
)
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
vessl.read_cluster(
cluster_name="seoul-cluster",
)
vessl.list_clusters(
**kwargs
)
List clusters in the default organization. If you want to override the default organization, then pass
organization_name as **kwargs.Example
vessl.list_clusters()
vessl.delete_cluster(
cluster_id: int, **kwargs
)
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
vessl.delete_cluster(
cluster_id=1,
)
vessl.rename_cluster(
cluster_id: int, new_cluster_name: str, **kwargs
)
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
vessl.rename_cluster(
cluster_id=1,
new_cluster_name="seoul-cluster-2",
)
vessl.list_cluster_nodes(
cluster_id: int, **kwargs
)
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
vessl.list_cluster_nodes(
cluster_id=1,
)
Last modified 3mo ago