feat: clusters api

Author: Ruslan Gainutdinov

examples/clusters_example.py

@@ -13,7 +13,7 @@
 import os
 
 from verda import VerdaClient
-from verda.constants import Locations
+from verda.constants import Actions, Locations
 
 # Get credentials from environment variables
 CLIENT_ID = os.environ.get('VERDA_CLIENT_ID')
@@ -30,20 +30,21 @@ def create_cluster_example():
 
     # Create a cluster with 3 nodes
     cluster = verda.clusters.create(
-        name='my-compute-cluster',
-        instance_type='8V100.48V',
-        node_count=3,
-        image='ubuntu-24.04-cuda-12.8-open-docker',
+        hostname='my-compute-cluster',
+        cluster_type='16H200',
+        image='ubuntu-22.04-cuda-12.4-cluster',
         description='Example compute cluster for distributed training',
         ssh_key_ids=ssh_keys,
         location=Locations.FIN_03,
+        shared_volume_name='my-shared-volume',
+        shared_volume_size=30000,
     )
 
     print(f'Created cluster: {cluster.id}')
-    print(f'Cluster name: {cluster.name}')
+    print(f'Cluster hostname: {cluster.hostname}')
     print(f'Cluster status: {cluster.status}')
-    print(f'Number of nodes: {cluster.node_count}')
-    print(f'Instance type: {cluster.instance_type}')
+    print(f'Cluster cluster_type: {cluster.cluster_type}')
+    print(f'Cluster worker_nodes: {cluster.worker_nodes}')
     print(f'Location: {cluster.location}')
 
     return cluster
@@ -56,7 +57,9 @@ def list_clusters_example():
 
     print(f'\nFound {len(clusters)} cluster(s):')
     for cluster in clusters:
-        print(f'  - {cluster.name} ({cluster.id}): {cluster.status} - {cluster.node_count} nodes')
+        print(
+            f'  - {cluster.hostname} ({cluster.id}): {cluster.status} - {len(cluster.worker_nodes)} nodes'
+        )
 
     # Get clusters with specific status
     running_clusters = verda.clusters.get(status=verda.constants.cluster_status.RUNNING)
@@ -71,45 +74,13 @@ def get_cluster_by_id_example(cluster_id: str):
 
     print('\nCluster details:')
     print(f'  ID: {cluster.id}')
-    print(f'  Name: {cluster.name}')
+    print(f'  Name: {cluster.hostname}')
     print(f'  Description: {cluster.description}')
     print(f'  Status: {cluster.status}')
-    print(f'  Instance type: {cluster.instance_type}')
-    print(f'  Node count: {cluster.node_count}')
+    print(f'  Cluster type: {cluster.cluster_type}')
     print(f'  Created at: {cluster.created_at}')
-    if cluster.master_ip:
-        print(f'  Master IP: {cluster.master_ip}')
-    if cluster.endpoint:
-        print(f'  Endpoint: {cluster.endpoint}')
-
-    return cluster
-
-
-def get_cluster_nodes_example(cluster_id: str):
-    """Get all nodes in a cluster."""
-    nodes = verda.clusters.get_nodes(cluster_id)
-
-    print(f'\nCluster has {len(nodes)} node(s):')
-    for i, node in enumerate(nodes, 1):
-        print(f'\n  Node {i}:')
-        print(f'    ID: {node.id}')
-        print(f'    Hostname: {node.hostname}')
-        print(f'    Status: {node.status}')
-        print(f'    IP: {node.ip}')
-        print(f'    Instance type: {node.instance_type}')
-
-    return nodes
-
-
-def scale_cluster_example(cluster_id: str, new_node_count: int):
-    """Scale a cluster to a new number of nodes."""
-    print(f'\nScaling cluster {cluster_id} to {new_node_count} nodes...')
-
-    cluster = verda.clusters.scale(cluster_id, new_node_count)
-
-    print('Cluster scaled successfully')
-    print(f'Current node count: {cluster.node_count}')
-    print(f'Cluster status: {cluster.status}')
+    print(f'  Public IP: {cluster.ip}')
+    print(f'  Worker nodes: {len(cluster.worker_nodes)}')
 
     return cluster
 
@@ -118,7 +89,7 @@ def delete_cluster_example(cluster_id: str):
     """Delete a cluster."""
     print(f'\nDeleting cluster {cluster_id}...')
 
-    verda.clusters.delete(cluster_id)
+    verda.clusters.action(cluster_id, Actions.DELETE)
 
     print('Cluster deleted successfully')
 
@@ -140,14 +111,6 @@ def main():
     print('\n3. Getting cluster details...')
     get_cluster_by_id_example(cluster_id)
 
-    # Get cluster nodes
-    print('\n4. Getting cluster nodes...')
-    get_cluster_nodes_example(cluster_id)
-
-    # Scale the cluster
-    print('\n5. Scaling the cluster...')
-    scale_cluster_example(cluster_id, 5)
-
     # Delete the cluster
     print('\n6. Deleting the cluster...')
     delete_cluster_example(cluster_id)

tests/integration_tests/conftest.py

@@ -9,7 +9,7 @@
 Make sure to run the server and the account has enough balance before running the tests
 """
 
-BASE_URL = 'http://localhost:3010/v1'
+BASE_URL = os.getenv('VERDA_BASE_URL', 'https://api.verda.com/v1')
 
 # Load env variables, make sure there's an env file with valid client credentials
 load_dotenv()

tests/integration_tests/test_clusters.py

@@ -0,0 +1,42 @@
+import os
+
+import pytest
+
+from verda import VerdaClient
+from verda.constants import Locations
+
+IN_GITHUB_ACTIONS = os.getenv('GITHUB_ACTIONS') == 'true'
+
+
+@pytest.mark.skipif(IN_GITHUB_ACTIONS, reason="Test doesn't work in Github Actions.")
+@pytest.mark.withoutresponses
+class TestClusters:
+    def test_create_cluster(self, verda_client: VerdaClient):
+        # get ssh key
+        ssh_key = verda_client.ssh_keys.get()[0]
+
+        # create instance
+        cluster = verda_client.clusters.create(
+            hostname='test-instance',
+            location=Locations.FIN_03,
+            cluster_type='16H200',
+            description='test instance',
+            image='ubuntu-22.04-cuda-12.4-cluster',
+            ssh_key_ids=[ssh_key.id],
+        )
+
+        # assert instance is created
+        assert cluster.id is not None
+        assert (
+            cluster.status == verda_client.constants.instance_status.PROVISIONING
+            or cluster.status == verda_client.constants.instance_status.RUNNING
+        )
+
+        assert cluster.worker_nodes is not None
+        assert len(cluster.worker_nodes) == 2
+        assert cluster.ip is not None
+
+        print(cluster)
+
+        # delete instance
+        # verda_client.clusters.action(cluster.id, 'delete')

verda/clusters/__init__.py

@@ -1,5 +1,5 @@
 """Clusters service for managing compute clusters."""
 
-from verda.clusters._clusters import Cluster, ClusterNode, ClustersService
+from verda.clusters._clusters import Cluster, ClusterWorkerNode, ClustersService
 
-__all__ = ['Cluster', 'ClusterNode', 'ClustersService']
+__all__ = ['Cluster', 'ClusterWorkerNode', 'ClustersService']