[SDK] Add cluster metadata update support (#150)

* [SDK] Add cluster metadata update support

Expose PUT /clusters/{id}/metadata so org admins can toggle
deployment_creation_disabled, matching platform#4273.

* fix lint

Author: michaelshin

centml/sdk/api.py

@@ -10,6 +10,7 @@
     CreateDynamoDeploymentRequest,
     CreateJobDeploymentRequest,
     CreateHardwareInstanceRequest,
+    UpdateClusterMetadataRequest,
     ApiException,
     InviteUserRequest,
     Metric,
@@ -127,6 +128,9 @@ def resume(self, id):
     def get_clusters(self):
         return self._api.get_clusters_clusters_get()
 
+    def update_cluster_metadata(self, cluster_id: int, request: UpdateClusterMetadataRequest):
+        return self._api.update_cluster_metadata_clusters_cluster_id_metadata_put(cluster_id, request)
+
     def get_hardware_instances(self, cluster_id=None):
         return self._api.get_hardware_instances_hardware_instances_get(
             cluster_id=cluster_id if cluster_id else None

examples/sdk/get_clusters.py

@@ -7,6 +7,7 @@
 - Cluster Name (Prometheus-compatible identifier)
 - Display Name (human-readable)
 - Region
+- Whether new deployment creation is disabled on the cluster
 """
 
 import click
@@ -30,10 +31,11 @@ def display_clusters(clusters):
 
     for cluster in sorted(clusters, key=lambda x: x.id):
         region = cluster.region if cluster.region else "N/A"
-        click.echo(f"ID:           {cluster.id}")
-        click.echo(f"Cluster Name: {cluster.cluster_name}")
-        click.echo(f"Display Name: {cluster.display_name}")
-        click.echo(f"Region:       {region}")
+        click.echo(f"ID:                           {cluster.id}")
+        click.echo(f"Cluster Name:                 {cluster.cluster_name}")
+        click.echo(f"Display Name:                 {cluster.display_name}")
+        click.echo(f"Region:                       {region}")
+        click.echo(f"Deployment Creation Disabled: {cluster.deployment_creation_disabled}")
         click.echo("-" * 40)
 
 

examples/sdk/manage_cluster_metadata.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python3
+"""
+Example showing how to manage cluster metadata with the CentML SDK.
+
+Covers listing clusters (including deployment_creation_disabled) and updating
+that flag via PUT /clusters/{cluster_id}/metadata. Running this script lists
+clusters you can access; the update helper shows the call pattern and is not
+invoked automatically.
+
+This uses the centml CLI authentication, so make sure you are logged in to the
+centml CLI before running it. Updating cluster metadata requires admin
+privileges (PERM_ADMIN_MANAGE_HARDWARE) and only works on org-owned clusters
+(global clusters return 404).
+"""
+
+from centml.sdk import UpdateClusterMetadataRequest
+from centml.sdk.api import get_centml_client
+
+
+def list_clusters():
+    """List accessible clusters and whether new deployments are disabled."""
+    with get_centml_client() as client:
+        clusters = client.get_clusters().results
+
+    if not clusters:
+        print("No clusters found.")
+        return
+
+    print(f"\nFound {len(clusters)} cluster(s)\n")
+    for cluster in sorted(clusters, key=lambda x: x.id):
+        region = cluster.region if cluster.region else "N/A"
+        print(f"ID:                           {cluster.id}")
+        print(f"Cluster Name:                 {cluster.cluster_name}")
+        print(f"Display Name:                 {cluster.display_name}")
+        print(f"Region:                       {region}")
+        print(f"Deployment Creation Disabled: {cluster.deployment_creation_disabled}")
+        print("-" * 40)
+
+
+def update_cluster_metadata(cluster_id: int, deployment_creation_disabled: bool):
+    """Toggle whether new deployments can be created on an org-owned cluster."""
+    request = UpdateClusterMetadataRequest(deployment_creation_disabled=deployment_creation_disabled)
+    with get_centml_client() as client:
+        cluster = client.update_cluster_metadata(cluster_id, request)
+    print(
+        f"Updated cluster {cluster.id} ({cluster.display_name}): "
+        f"deployment_creation_disabled={cluster.deployment_creation_disabled}"
+    )
+    return cluster
+
+
+if __name__ == "__main__":
+    list_clusters()
+    # Example (requires admin privileges on an org-owned cluster):
+    # update_cluster_metadata(cluster_id=1, deployment_creation_disabled=True)

requirements.txt

@@ -5,5 +5,5 @@ pyjwt>=2.8.0
 cryptography==48.0.1
 websockets>=16.0
 pyte>=0.8.0
-platform-api-python-client==4.23.1
+platform-api-python-client==4.25.0
 click>=8.4.1

tests/test_sdk_api.py

@@ -7,6 +7,7 @@
     CreateHardwareInstanceRequest,
     CreateJobDeploymentRequest,
     DeploymentType,
+    UpdateClusterMetadataRequest,
 )
 
 from centml.sdk import ApiException
@@ -164,6 +165,24 @@ def test_get_centml_client_uses_authenticated_generated_client():
     external_api_cls.assert_called_once_with(generated_api_client)
 
 
+def test_generated_client_exposes_cluster_metadata_contract():
+    assert hasattr(platform_api_python_client.EXTERNALApi, "update_cluster_metadata_clusters_cluster_id_metadata_put")
+    assert hasattr(platform_api_python_client, "UpdateClusterMetadataRequest")
+
+
+def test_update_cluster_metadata_delegates_to_platform_client():
+    api = MagicMock()
+    expected_response = MagicMock()
+    api.update_cluster_metadata_clusters_cluster_id_metadata_put.return_value = expected_response
+    request = UpdateClusterMetadataRequest(deployment_creation_disabled=True)
+    client = CentMLClient(api)
+
+    response = client.update_cluster_metadata(42, request)
+
+    assert response is expected_response
+    api.update_cluster_metadata_clusters_cluster_id_metadata_put.assert_called_once_with(42, request)
+
+
 def test_get_hardware_instances_returns_results():
     api = MagicMock()
     expected_results = [SimpleNamespace(id=1), SimpleNamespace(id=2)]