VESSL Docs
🗒 Release Notes 🙌 Community Slack
Search…
⌃K
Links

Cluster API

​

create_cluster

vessl.create_cluster(
cluster_name: str, kubernetes_namespace: str = 'vessl',
extra_helm_values: List[str] = [], kubeconfig_path: str = '', **kwargs
)
Create a VESSL cluster by installing VESSL agent to given Kubernetes namespace. If you want to override the default organization, then pass organization_name as **kwargs.
Args
  • cluster_name (str) : Cluster name.
  • kubernetes_namespace (str) : Kubernetes namespace to install VESSL agent. defaults to "vessl".
  • extra_helm_values (list[str]) : Helm values to pass to cluster install command. See https://github.com/vessl-ai/cluster-resources/blob/main/helm-chart/values.yaml for available Helm values.
  • kubeconfig_path (str) : Path to kubeconfig file.
Example
vessl.install_cluster(
cluster_name="seoul-cluster",
)
​

read_cluster

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",
)
​

list_clusters

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()
​

delete_cluster

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,
)
​

rename_cluster

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",
)
​

list_cluster_nodes

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,
)
Previous
Experiment API
Next
Image API
Last modified 2mo ago