anyscale 0.25.11__tar.gz → 0.26.0__tar.gz

{anyscale-0.25.11 → anyscale-0.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: anyscale
-Version: 0.25.11
+Version: 0.26.0
 Summary: Command Line Interface for Anyscale
 Author: Anyscale Inc.
 License: AS License

{anyscale-0.25.11 → anyscale-0.26.0}/anyscale/_private/anyscale_client/anyscale_client.py

@@ -546,9 +546,7 @@ class AnyscaleClient(AnyscaleClientInterface):
     @handle_api_exceptions
     def get_cloud(self, *, cloud_id: str) -> Optional[Cloud]:
         try:
-            cloud: Cloud = self._internal_api_client.get_cloud_api_v2_clouds_cloud_id_get(
-                cloud_id
-            ).result
+            cloud: Cloud = self._external_api_client.get_cloud(cloud_id=cloud_id).result
             return cloud
         except InternalApiException as e:
             if e.status == 404:
@@ -556,6 +554,21 @@ class AnyscaleClient(AnyscaleClientInterface):
 
             raise e from None
 
+    @handle_api_exceptions
+    def get_cloud_by_name(self, *, name) -> Optional[Cloud]:
+        cloud_id = self.get_cloud_id(cloud_name=name)
+        return self.get_cloud(cloud_id=cloud_id)
+
+    @handle_api_exceptions
+    def get_default_cloud(self) -> Optional[Cloud]:
+        try:
+            return self._external_api_client.get_default_cloud().result
+        except InternalApiException as e:
+            if e.status == 404:
+                return None
+
+            raise e from None
+
     @handle_api_exceptions
     def add_cloud_collaborators(
         self, cloud_id: str, collaborators: List[CreateCloudCollaborator]

{anyscale-0.25.11 → anyscale-0.26.0}/anyscale/_private/anyscale_client/common.py

@@ -150,6 +150,19 @@ class AnyscaleClientInterface(ABC):
         """
         raise NotImplementedError
 
+    @abstractmethod
+    def get_cloud_by_name(self, *, name: str) -> Optional[Cloud]:
+        """Get the cloud model for the provided cloud name.
+
+        Returns `None` if the cloud name was not found.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_default_cloud(self) -> Optional[Cloud]:
+        """Get the user's default cloud."""
+        raise NotImplementedError
+
     @abstractmethod
     def add_cloud_collaborators(
         self, cloud_id: str, collaborators: List[CreateCloudCollaborator]

{anyscale-0.25.11 → anyscale-0.26.0}/anyscale/_private/anyscale_client/fake_anyscale_client.py

@@ -368,6 +368,15 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
     def get_cloud(self, *, cloud_id: str) -> Optional[Cloud]:
         return self._clouds.get(cloud_id, None)
 
+    def get_cloud_by_name(self, *, name: str) -> Optional[Cloud]:
+        for c in self._clouds.values():
+            if c.name == name:
+                return c
+        return None
+
+    def get_default_cloud(self) -> Optional[Cloud]:
+        return self._clouds.get(self.DEFAULT_CLOUD_ID, None)
+
     def add_cloud_collaborators(
         self, cloud_id: str, collaborators: List[CreateCloudCollaborator]
     ) -> None:

{anyscale-0.25.11 → anyscale-0.26.0}/anyscale/_private/docgen/__main__.py

@@ -11,7 +11,10 @@ from anyscale import scripts
 from anyscale._private.docgen.generator import MarkdownGenerator, Module
 from anyscale.aggregated_instance_usage.models import DownloadCSVFilters
 from anyscale.cloud.models import (
+    Cloud,
     CloudPermissionLevel,
+    CloudProvider,
+    ComputeStack,
     CreateCloudCollaborator,
 )
 from anyscale.commands import (
@@ -443,10 +446,22 @@ ALL_MODULES = [
             cloud_commands.cloud_config_update,
             cloud_commands.cloud_set_default,
             cloud_commands.add_collaborators,
+            cloud_commands.get_cloud,
+            cloud_commands.get_default_cloud,
         ],
         sdk_prefix="anyscale.cloud",
-        sdk_commands=[anyscale.cloud.add_collaborators],
-        models=[CloudPermissionLevel, CreateCloudCollaborator],
+        sdk_commands=[
+            anyscale.cloud.add_collaborators,
+            anyscale.cloud.get,
+            anyscale.cloud.get_default,
+        ],
+        models=[
+            CloudPermissionLevel,
+            CreateCloudCollaborator,
+            Cloud,
+            ComputeStack,
+            CloudProvider,
+        ],
         cli_command_group_prefix={cloud_commands.cloud_config_update: "config"},
         legacy_sdk_commands={
             # limited support, no replacement yet

{anyscale-0.25.11 → anyscale-0.26.0}/anyscale/cloud/__init__.py

@@ -11,9 +11,14 @@ from anyscale.cloud._private.cloud_sdk import PrivateCloudSDK
 from anyscale.cloud.commands import (
     _ADD_COLLABORATORS_ARG_DOCSTRINGS,
     _ADD_COLLABORATORS_EXAMPLE,
+    _GET_ARG_DOCSTRINGS,
+    _GET_DEFAULT_EXAMPLE,
+    _GET_EXAMPLE,
     add_collaborators,
+    get,
+    get_default,
 )
-from anyscale.cloud.models import CreateCloudCollaborator
+from anyscale.cloud.models import Cloud, CreateCloudCollaborator
 from anyscale.connect import ClientBuilder
 
 
@@ -31,12 +36,43 @@ class CloudSDK:
         doc_py_example=_ADD_COLLABORATORS_EXAMPLE,
         arg_docstrings=_ADD_COLLABORATORS_ARG_DOCSTRINGS,
     )
-    def add_collaborators(  # noqa: F811
-        self, cloud: str, collaborators: List[CreateCloudCollaborator]
+    def add_collaborators(
+        self, cloud: str, collaborators: List[CreateCloudCollaborator],
     ) -> str:
-        """Batch add collaborators to a cloud."""
+        """
+        Batch add collaborators to a cloud.
+
+        :param cloud: The cloud to add users to.
+        :param collaborators: The list of collaborators to add to the cloud.
+        """
         return self._private_sdk.add_collaborators(cloud, collaborators)
 
+    @sdk_docs(
+        doc_py_example=_GET_EXAMPLE, arg_docstrings=_GET_ARG_DOCSTRINGS,
+    )
+    def get_cloud(
+        self, id: Optional[str], name: Optional[str],  # noqa: A002
+    ) -> Optional[Cloud]:
+        """
+        Retrieve a cloud by its name or ID.
+
+        :param id: The ID of the cloud to retrieve.
+        :param name: The name of the cloud to retrieve.
+        :return: A ``Cloud`` object if found, otherwise ``None``.
+        """
+        return self._private_sdk.get(id=id, name=name)
+
+    @sdk_docs(
+        doc_py_example=_GET_DEFAULT_EXAMPLE, arg_docstrings={},
+    )
+    def get_default_cloud(self) -> Optional[Cloud]:
+        """
+        Get the default cloud for your organization.
+
+        :return: The default ``Cloud`` object if it exists, otherwise ``None``.
+        """
+        return self._private_sdk.get_default()
+
 
 # Note: indentation here matches that of connect.py::ClientBuilder.
 BUILDER_HELP_FOOTER = """
@@ -48,13 +84,16 @@ class CloudModule(ModuleType):
     """
     A custom callable module object for `anyscale.cloud`.
 
-    This hack is needed since `anyscale.cloud` is a function for Anyscale connect but also a module for the SDK.
+    This hack is needed since `anyscale.cloud` is a function for Anyscale connect
+    but also a module for the SDK.
     """
 
     def __init__(self):
         # Expose attributes from the SDK.
         self.CloudSDK = CloudSDK
         self.add_collaborators = add_collaborators
+        self.get = get
+        self.get_default = get_default
 
         # Expose Anyscale connect
         self.new_builder = self._new_builder()

anyscale-0.26.0/anyscale/cloud/_private/cloud_sdk.py

@@ -0,0 +1,82 @@
+from typing import List, Optional
+
+from anyscale._private.sdk.base_sdk import BaseSDK
+from anyscale.client.openapi_client.models import (
+    Cloud as CloudModel,
+    CreateCloudCollaborator as CreateCloudCollaboratorModel,
+)
+from anyscale.cloud.models import (
+    Cloud,
+    CloudProvider,
+    ComputeStack,
+    CreateCloudCollaborator,
+)
+
+
+class PrivateCloudSDK(BaseSDK):
+    def add_collaborators(
+        self, cloud: str, collaborators: List[CreateCloudCollaborator]
+    ) -> str:
+        cloud_id = self.client.get_cloud_id(cloud_name=cloud, compute_config_id=None)
+
+        return self.client.add_cloud_collaborators(
+            cloud_id=cloud_id,
+            collaborators=[
+                CreateCloudCollaboratorModel(
+                    email=collaborator.email,
+                    permission_level=collaborator.permission_level.lower(),
+                )
+                for collaborator in collaborators
+            ],
+        )
+
+    def get(
+        self, id: Optional[str], name: Optional[str],  # noqa: A002
+    ) -> Optional[Cloud]:
+        if (id and name) or (not id and not name):
+            raise ValueError("Provide exactly one of 'id' or 'name'.")
+
+        if id:
+            openapi_cloud = self.client.get_cloud(cloud_id=id)
+        else:
+            assert name is not None, "Name must be provided if id is not."
+            openapi_cloud = self.client.get_cloud_by_name(name=name)
+
+        return self._to_sdk_cloud(openapi_cloud)
+
+    def get_default(self) -> Optional[Cloud]:
+        openapi_cloud = self.client.get_default_cloud()
+
+        return self._to_sdk_cloud(openapi_cloud)
+
+    def _to_sdk_cloud(self, openapi_cloud: Optional["CloudModel"]) -> Optional[Cloud]:
+        if openapi_cloud is None:
+            return None
+
+        # Validate provider, default to UNKNOWN if validation fails
+        if openapi_cloud.provider is not None:
+            try:
+                provider = CloudProvider.validate(openapi_cloud.provider)
+            except ValueError:
+                provider = CloudProvider.UNKNOWN
+        else:
+            provider = CloudProvider.UNKNOWN
+
+        # Validate compute_stack, default to UNKNOWN if validation fails
+        if openapi_cloud.compute_stack is not None:
+            try:
+                compute_stack = ComputeStack.validate(openapi_cloud.compute_stack)
+            except ValueError:
+                compute_stack = ComputeStack.UNKNOWN
+        else:
+            compute_stack = ComputeStack.UNKNOWN
+
+        return Cloud(
+            id=openapi_cloud.id,
+            name=openapi_cloud.name,
+            provider=provider,
+            region=openapi_cloud.region,
+            created_at=openapi_cloud.created_at,
+            is_default=openapi_cloud.is_default,
+            compute_stack=compute_stack,
+        )

anyscale-0.26.0/anyscale/cloud/commands.py

@@ -0,0 +1,113 @@
+from typing import List, Optional
+
+from anyscale._private.sdk import sdk_command
+from anyscale.cloud._private.cloud_sdk import Cloud, PrivateCloudSDK
+from anyscale.cloud.models import CreateCloudCollaborator
+
+
+_CLOUD_SDK_SINGLETON_KEY = "cloud_sdk"
+
+_ADD_COLLABORATORS_EXAMPLE = """
+import anyscale
+from anyscale.cloud.models import CloudPermissionLevel, CreateCloudCollaborator
+
+anyscale.cloud.add_collaborators(
+    cloud="cloud_name",
+    collaborators=[
+        CreateCloudCollaborator(
+            email="test1@anyscale.com",
+            permission_level=CloudPermissionLevel.WRITE,
+        ),
+        CreateCloudCollaborator(
+            email="test2@anyscale.com",
+            permission_level=CloudPermissionLevel.READONLY,
+        ),
+    ],
+)
+"""
+
+_ADD_COLLABORATORS_ARG_DOCSTRINGS = {
+    "cloud": "The cloud to add users to.",
+    "collaborators": "The list of collaborators to add to the cloud.",
+}
+
+
+@sdk_command(
+    _CLOUD_SDK_SINGLETON_KEY,
+    PrivateCloudSDK,
+    doc_py_example=_ADD_COLLABORATORS_EXAMPLE,
+    arg_docstrings=_ADD_COLLABORATORS_ARG_DOCSTRINGS,
+)
+def add_collaborators(
+    cloud: str, collaborators: List[CreateCloudCollaborator], *, _sdk: PrivateCloudSDK,
+) -> str:
+    """
+    Batch add collaborators to a cloud.
+
+    :param cloud: The cloud to add users to.
+    :param collaborators: The list of collaborators to add to the cloud.
+    """
+    return _sdk.add_collaborators(cloud, collaborators)
+
+
+_GET_EXAMPLE = """
+import anyscale
+
+# Get a cloud by ID
+cloud_by_id = anyscale.cloud.get(id="cloud_id")
+
+# Get a cloud by name
+cloud_by_name = anyscale.cloud.get(name="cloud_name")
+"""
+
+_GET_ARG_DOCSTRINGS = {
+    "id": "The ID of the cloud to retrieve.",
+    "name": "The name of the cloud to retrieve.",
+}
+
+
+@sdk_command(
+    _CLOUD_SDK_SINGLETON_KEY,
+    PrivateCloudSDK,
+    doc_py_example=_GET_EXAMPLE,
+    arg_docstrings=_GET_ARG_DOCSTRINGS,
+)
+def get(
+    id: Optional[str] = None,  # noqa: A002
+    name: Optional[str] = None,
+    *,
+    _sdk: PrivateCloudSDK,
+) -> Optional[Cloud]:
+    """
+    Get the cloud model for the provided cloud ID or name.
+
+    If neither ID nor name is provided, returns `None`.
+
+    :param id: The ID of the cloud to retrieve.
+    :param name: The name of the cloud to retrieve.
+    :return: A `Cloud` object if found, otherwise `None`.
+    """
+    return _sdk.get(id=id, name=name)
+
+
+_GET_DEFAULT_EXAMPLE = """
+import anyscale
+
+# Get the user's default cloud
+default_cloud = anyscale.cloud.get_default()
+"""
+
+
+@sdk_command(
+    _CLOUD_SDK_SINGLETON_KEY,
+    PrivateCloudSDK,
+    doc_py_example=_GET_DEFAULT_EXAMPLE,
+    arg_docstrings={},
+)
+def get_default(*, _sdk: PrivateCloudSDK,) -> Optional[Cloud]:
+    """
+    Get the user's default cloud.
+
+    :return: The default `Cloud` object if it exists, otherwise `None`.
+    """
+    return _sdk.get_default()

anyscale-0.26.0/anyscale/cloud/models.py

@@ -0,0 +1,209 @@
+from dataclasses import dataclass, field
+from datetime import datetime
+from typing import Any, Dict, List, Optional, Union
+
+from anyscale._private.models import ModelBase, ModelEnum
+
+
+class CloudPermissionLevel(ModelEnum):
+    WRITE = "WRITE"
+    READONLY = "READONLY"
+
+    __docstrings__ = {
+        WRITE: "Write permission level for the cloud",
+        READONLY: "Readonly permission level for the cloud",
+    }  # type: ignore
+
+
+@dataclass(frozen=True)
+class CreateCloudCollaborator(ModelBase):
+    """User to be added as a collaborator to a cloud.
+    """
+
+    __doc_py_example__ = """\
+import anyscale
+from anyscale.cloud.models import CloudPermissionLevel, CreateCloudCollaborator
+
+create_cloud_collaborator = CreateCloudCollaborator(
+   # Email of the user to be added as a collaborator
+    email="test@anyscale.com",
+    # Permission level for the user to the cloud (CloudPermissionLevel.WRITE, CloudPermissionLevel.READONLY)
+    permission_level=CloudPermissionLevel.READONLY,
+)
+"""
+
+    def _validate_email(self, email: str):
+        if not isinstance(email, str):
+            raise TypeError("Email must be a string.")
+
+    email: str = field(
+        metadata={"docstring": "Email of the user to be added as a collaborator."},
+    )
+
+    def _validate_permission_level(
+        self, permission_level: CloudPermissionLevel
+    ) -> CloudPermissionLevel:
+        if isinstance(permission_level, str):
+            return CloudPermissionLevel.validate(permission_level)  # type: ignore
+        elif isinstance(permission_level, CloudPermissionLevel):
+            return permission_level
+        else:
+            raise TypeError(
+                f"'permission_level' must be a 'CloudPermissionLevel' (it is {type(permission_level)})."
+            )
+
+    permission_level: CloudPermissionLevel = field(  # type: ignore
+        default=CloudPermissionLevel.READONLY,  # type: ignore
+        metadata={
+            "docstring": "Permission level the added user should have for the cloud"  # type: ignore
+            f"(one of: {','.join([str(m.value) for m in CloudPermissionLevel])}",  # type: ignore
+        },
+    )
+
+
+@dataclass(frozen=True)
+class CreateCloudCollaborators(ModelBase):
+    """List of users to be added as collaborators to a cloud.
+    """
+
+    __doc_py_example__ = """\
+import anyscale
+from anyscale.cloud.models import CloudPermissionLevel, CreateCloudCollaborator, CreateCloudCollaborators
+
+create_cloud_collaborator = CreateCloudCollaborator(
+   # Email of the user to be added as a collaborator
+    email="test@anyscale.com",
+    # Permission level for the user to the cloud (CloudPermissionLevel.WRITE, CloudPermissionLevel.READONLY)
+    permission_level=CloudPermissionLevel.READONLY,
+)
+create_cloud_collaborators = CreateCloudCollaborators(
+    collaborators=[create_cloud_collaborator]
+)
+"""
+
+    collaborators: List[Dict[str, Any]] = field(
+        metadata={
+            "docstring": "List of users to be added as collaborators to a cloud."
+        },
+    )
+
+    def _validate_collaborators(self, collaborators: List[Dict[str, Any]]):
+        if not isinstance(collaborators, list):
+            raise TypeError("Collaborators must be a list.")
+
+
+class ComputeStack(ModelEnum):
+    UNKNOWN = "UNKNOWN"
+    VM = "VM"
+    K8S = "K8S"
+
+    __docstrings__ = {
+        UNKNOWN: "Unknown compute stack.",
+        VM: "Virtual machine-based compute stack.",
+        K8S: "Kubernetes-based compute stack.",
+    }  # type: ignore
+
+
+class CloudProvider(ModelEnum):
+    UNKNOWN = "UNKNOWN"
+    AWS = "AWS"
+    GCP = "GCP"
+    AZURE = "AZURE"
+
+    __docstrings__ = {
+        UNKNOWN: "Unknown cloud provider.",
+        AWS: "Amazon Web Services.",
+        GCP: "Google Cloud Platform.",
+        AZURE: "Microsoft Azure.",
+    }  # type: ignore
+
+
+@dataclass(frozen=True)
+class Cloud(ModelBase):
+    """Minimal Cloud resource model."""
+
+    __doc_py_example__ = """\
+from datetime import datetime
+from anyscale.cloud.models import Cloud, CloudProvider, ComputeStack
+
+cloud = Cloud(
+    name="my-cloud",
+    id="cloud-123",
+    provider="AWS",  # This will be validated as CloudProvider.AWS
+    region="us-west-2",
+    created_at=datetime.now(),
+    is_default=True,
+    compute_stack="VM"  # This will be validated as ComputeStack.VM
+)
+"""
+
+    name: str = field(metadata={"docstring": "Name of this Cloud."})
+    id: str = field(metadata={"docstring": "Unique identifier for this Cloud."})
+    provider: Union[CloudProvider, str] = field(
+        metadata={
+            "docstring": "Cloud provider (AWS, GCP, AZURE) or UNKNOWN if not recognized."
+        },
+    )
+    compute_stack: Union[ComputeStack, str] = field(
+        metadata={
+            "docstring": "The compute stack associated with this cloud's primary cloud resource, or UNKNOWN if not recognized."
+        },
+    )
+    region: Optional[str] = field(
+        default=None, metadata={"docstring": "Region for this Cloud."}
+    )
+    created_at: Optional[datetime] = field(
+        default=None, metadata={"docstring": "When the Cloud was created."}
+    )
+    is_default: Optional[bool] = field(
+        default=None, metadata={"docstring": "Whether this is the default cloud."}
+    )
+
+    def _validate_name(self, name: str) -> str:
+        if not isinstance(name, str) or not name.strip():
+            raise ValueError("name must be a non-empty string")
+        return name
+
+    def _validate_id(self, id: str) -> str:  # noqa: A002
+        if not isinstance(id, str) or not id.strip():
+            raise ValueError("id must be a non-empty string")
+        return id
+
+    def _validate_provider(self, provider: Union[CloudProvider, str]) -> CloudProvider:
+        if isinstance(provider, str):
+            # This will raise a ValueError if the provider is unrecognized.
+            provider = CloudProvider(provider)
+        elif not isinstance(provider, CloudProvider):
+            raise TypeError("'provider' must be a CloudProvider.")
+
+        return provider
+
+    def _validate_region(self, region: Optional[str]) -> Optional[str]:
+        if region is not None and not isinstance(region, str):
+            raise TypeError("region must be a string")
+        return region
+
+    def _validate_created_at(
+        self, created_at: Optional[datetime]
+    ) -> Optional[datetime]:
+        if created_at is None:
+            return None
+        if not isinstance(created_at, datetime):
+            raise TypeError("created_at must be a datetime object")
+        return created_at
+
+    def _validate_is_default(self, is_default: Optional[bool]) -> Optional[bool]:
+        if is_default is not None and not isinstance(is_default, bool):
+            raise TypeError("is_default must be a bool")
+        return is_default
+
+    def _validate_compute_stack(
+        self, compute_stack: Union[ComputeStack, str]
+    ) -> ComputeStack:
+        if isinstance(compute_stack, str):
+            # This will raise a ValueError if the compute_stack is unrecognized.
+            compute_stack = ComputeStack(compute_stack)
+        elif not isinstance(compute_stack, ComputeStack):
+            raise TypeError("'compute_stack' must be a ComputeStack.")
+
+        return compute_stack

{anyscale-0.25.11 → anyscale-0.26.0}/anyscale/commands/cloud_commands.py

@@ -1090,3 +1090,79 @@ def add_collaborators(cloud: str, users_file: str,) -> None:
     log.info(
         f"Successfully added {len(collaborators.collaborators)} collaborators to cloud {cloud}."
     )
+
+
+@cloud_cli.command(
+    name="get",
+    help="Get information about a specific cloud.",
+    cls=AnyscaleCommand,
+    example=command_examples.CLOUD_GET_CLOUD_EXAMPLE,
+)
+@click.option(
+    "--name",
+    "-n",
+    help="Name of the cloud to get information about.",
+    type=str,
+    required=False,
+)
+@click.option(
+    "--cloud-id",
+    "--id",
+    help="ID of the cloud to get information about.",
+    type=str,
+    required=False,
+)
+def get_cloud(cloud_id: Optional[str], name: Optional[str]) -> None:
+    """
+    Retrieve a cloud by its name or ID and display its details.
+
+    :param cloud_id: The ID of the cloud to retrieve.
+    :param name: The name of the cloud to retrieve.
+    """
+    # Validate that exactly one of --name or --cloud-id is provided
+    if (cloud_id and name) or (not cloud_id and not name):
+        log.error("Please provide exactly one of --name or --cloud-id.")
+        return
+
+    try:
+        cloud = anyscale.cloud.get(id=cloud_id, name=name)
+
+        if not cloud:
+            log.error("Cloud not found.")
+            return
+
+        cloud_dict = cloud.to_dict() if hasattr(cloud, "to_dict") else cloud.__dict__
+
+        print(yaml.dump(cloud_dict, sort_keys=False))
+
+    except ValueError as e:
+        log.error(f"Error retrieving cloud: {e}")
+
+
+@cloud_cli.command(
+    name="get-default",
+    help="Get the default cloud for your organization.",
+    cls=AnyscaleCommand,
+    example=command_examples.CLOUD_GET_DEFAULT_CLOUD_EXAMPLE,
+)
+def get_default_cloud() -> None:
+    """
+    Retrieve and display the default cloud configured for your organization.
+    """
+    try:
+        default_cloud = anyscale.cloud.get_default()
+
+        if not default_cloud:
+            log.error("No default cloud found.")
+            return
+
+        cloud_dict = (
+            default_cloud.to_dict()
+            if hasattr(default_cloud, "to_dict")
+            else default_cloud.__dict__
+        )
+
+        print(yaml.dump(cloud_dict, sort_keys=False))
+
+    except ValueError as e:
+        log.error(f"Error retrieving default cloud: {e}")