Python SDKPythonPythonAistoreSdkAuthn

aistore.sdk.authn.cluster_manager

View as MarkdownOpen in Claude

Module Contents

Classes

NameDescription
ClusterManagerClusterManager class for handling operations on clusters within the context of authentication.

Data

logger

API

class aistore.sdk.authn.cluster_manager.ClusterManager(
    client: aistore.sdk.request_client.RequestClient
)

ClusterManager class for handling operations on clusters within the context of authentication.

This class provides methods to list, get, register, update, and delete clusters on AuthN server.

Parameters:

client
RequestClient

The request client to make HTTP requests.

client
RequestClient

RequestClient: The client this cluster manager uses to make requests.

aistore.sdk.authn.cluster_manager.ClusterManager.delete(
    cluster_id: typing.Optional[str] = None,
    cluster_alias: typing.Optional[str] = None
)

Delete a specific cluster by ID or alias.

Parameters:

cluster_id
Optional[str]Defaults to None

The ID of the cluster to delete. Defaults to None.

cluster_alias
Optional[str]Defaults to None

The alias of the cluster to delete. Defaults to None.

Raises:

  • ValueError: If neither cluster_id nor cluster_alias is provided.
  • AISError: If an error occurs while deleting the cluster
aistore.sdk.authn.cluster_manager.ClusterManager.get(
    cluster_id: typing.Optional[str] = None,
    cluster_alias: typing.Optional[str] = None
) -> aistore.sdk.authn.types.ClusterInfo

Retrieve a specific cluster by ID or alias.

Parameters:

cluster_id
Optional[str]Defaults to None

The ID of the cluster. Defaults to None.

cluster_alias
Optional[str]Defaults to None

The alias of the cluster. Defaults to None.

Returns: ClusterInfo

Information about the specified cluster.

Raises:

  • ValueError: If neither cluster_id nor cluster_alias is provided.
  • RuntimeError: If no cluster matches the provided ID or alias.
  • AISError: If an error occurs while getting the cluster.
aistore.sdk.authn.cluster_manager.ClusterManager.list() -> aistore.sdk.authn.types.ClusterList

Retrieve all clusters.

Returns: ClusterList

A list of all clusters.

Raises:

  • AISError: If an error occurs while listing clusters.
aistore.sdk.authn.cluster_manager.ClusterManager.register(
    cluster_alias: str,
    urls: typing.List[str]
) -> aistore.sdk.authn.types.ClusterInfo

Register a new cluster.

Parameters:

cluster_alias
str

The alias for the new cluster.

urls
List[str]

A list of URLs for the new cluster.

Returns: ClusterInfo

Information about the registered cluster.

Raises:

  • ValueError: If no URLs are provided or an invalid URL is provided.
  • AISError: If an error occurs while registering the cluster.
aistore.sdk.authn.cluster_manager.ClusterManager.update(
    cluster_id: str,
    cluster_alias: typing.Optional[str] = None,
    urls: typing.Optional[typing.List[str]] = None
) -> aistore.sdk.authn.types.ClusterInfo

Update an existing cluster.

Parameters:

cluster_id
str

The ID of the cluster to update.

cluster_alias
Optional[str]Defaults to None

The new alias for the cluster. Defaults to None.

urls
Optional[List[str]]Defaults to None

The new list of URLs for the cluster. Defaults to None.

Returns: ClusterInfo

Information about the updated cluster.

Raises:

  • ValueError: If neither cluster_alias nor urls are provided.
  • AISError: If an error occurs while updating the cluster
aistore.sdk.authn.cluster_manager.logger = get_logger(__name__)