Skip to main content

vantage_sdk.cluster.crud

Cluster CRUD SDK using the base CRUD classes.

Classes​

ClusterSDK()​

SDK for cluster CRUD operations using GraphQL API.

Methods​

  • create(self, ctx: typer.models.Context, resource_data: Dict[str, Any], **kwargs: Any) -> vantage_sdk.cluster.schema.Cluster: Create a new cluster.
  • create_cluster(self, ctx: typer.models.Context, name: str, cluster_type: str, cloud_account_id: int, description: str | None = None, provider_attributes: Dict[str, Any] | None = None, settings: Dict[str, Any] | None = None, **kwargs: Any) -> vantage_sdk.cluster.schema.Cluster: Create a new cluster with simplified parameters.
  • create_slurm_cluster(self, ctx: typer.models.Context, name: str, parent_cluster_name: str) -> Dict[str, Any]: Create a Slurm cluster within a K8s parent cluster.
  • create_slurm_cluster_in_k8s(self, ctx: typer.models.Context, name: str, parent_cluster_name: str, control_node_group: str, partitions: list[typing.Dict[str, typing.Any]], node_groups: list[typing.Dict[str, typing.Any]], exposed: bool = False, tls_enabled: bool = True, profiling_enabled: bool = False, bridge_enabled: bool = True, chart_values: Dict[str, Any] | None = None) -> Dict[str, Any]: Create a Slurm cluster within a K8s cluster via the unified API mutation.
  • delete(self, ctx: typer.models.Context, resource_id: str, **kwargs: Any) -> bool: Delete a cluster.
  • delete_cluster(self, ctx: typer.models.Context, cluster_name: str, **kwargs: Any) -> bool: Delete a cluster by name.
  • delete_slurm_cluster_in_k8s(self, ctx: typer.models.Context, name: str, parent_cluster_name: str) -> Dict[str, Any]: Delete a Slurm cluster record via the unified API mutation.
  • get(self, ctx: typer.models.Context, resource_id: str, **kwargs: Any) -> vantage_sdk.cluster.schema.Cluster | None: Get a specific cluster by name using GraphQL query with filtering.
  • get_cluster(self, ctx: typer.models.Context, cluster_name: str, **kwargs: Any) -> vantage_sdk.cluster.schema.Cluster | None: Get a specific cluster as a Cluster object.
  • get_cluster_by_name(self, ctx: typer.models.Context, cluster_name: str) -> vantage_sdk.cluster.schema.Cluster | None: Get cluster details by name with client secret and sssd_binder_password populated.
  • get_cluster_client_secret(self, ctx: typer.models.Context, client_id: str) -> str | None: Get the client secret for the cluster from vantage-api using GraphQL client auth.
  • get_slurm_cluster_client_id(self, ctx: typer.models.Context, slurm_cluster_name: str, parent_cluster_name: str) -> str | None: Look up an existing Slurm cluster's clientId via GraphQL.
  • list_clusters(self, ctx: typer.models.Context, **kwargs: Any) -> List[vantage_sdk.cluster.schema.Cluster]: List all clusters as Cluster objects.
  • update(self, ctx: typer.models.Context, resource_id: str, resource_data: Dict[str, Any], **kwargs: Any) -> vantage_sdk.cluster.schema.Cluster | None: Update an existing cluster.
  • update_cluster(self, ctx: typer.models.Context, name: str, description: str | None = None, status: str | None = None, settings: Dict[str, Any] | None = None, **kwargs: Any) -> vantage_sdk.cluster.schema.Cluster | None: Update an existing cluster with simplified parameters.
  • update_settings(self, ctx: typer.models.Context, cluster_name: str, settings: Dict[str, Any]) -> str: Update cluster settings.