anyscale 0.25.11__py3-none-any.whl → 0.26.1__py3-none-any.whl

anyscale/client/openapi_client/models/scheduler_info.py

@@ -34,15 +34,17 @@ class SchedulerInfo(object):
     """
     openapi_types = {
         'requests': 'list[RequestStateInfo]',
-        'machines': 'list[MachineStateInfo]'
+        'machines': 'list[MachineStateInfo]',
+        'recent_launch_failures': 'list[MachineLaunchFailure]'
     }
 
     attribute_map = {
         'requests': 'requests',
-        'machines': 'machines'
+        'machines': 'machines',
+        'recent_launch_failures': 'recent_launch_failures'
     }
 
-    def __init__(self, requests=None, machines=None, local_vars_configuration=None):  # noqa: E501
+    def __init__(self, requests=None, machines=None, recent_launch_failures=None, local_vars_configuration=None):  # noqa: E501
         """SchedulerInfo - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration()
@@ -50,10 +52,12 @@ class SchedulerInfo(object):
 
         self._requests = None
         self._machines = None
+        self._recent_launch_failures = None
         self.discriminator = None
 
         self.requests = requests
         self.machines = machines
+        self.recent_launch_failures = recent_launch_failures
 
     @property
     def requests(self):
@@ -105,6 +109,31 @@ class SchedulerInfo(object):
 
         self._machines = machines
 
+    @property
+    def recent_launch_failures(self):
+        """Gets the recent_launch_failures of this SchedulerInfo.  # noqa: E501
+
+        Recent launch failures.  # noqa: E501
+
+        :return: The recent_launch_failures of this SchedulerInfo.  # noqa: E501
+        :rtype: list[MachineLaunchFailure]
+        """
+        return self._recent_launch_failures
+
+    @recent_launch_failures.setter
+    def recent_launch_failures(self, recent_launch_failures):
+        """Sets the recent_launch_failures of this SchedulerInfo.
+
+        Recent launch failures.  # noqa: E501
+
+        :param recent_launch_failures: The recent_launch_failures of this SchedulerInfo.  # noqa: E501
+        :type: list[MachineLaunchFailure]
+        """
+        if self.local_vars_configuration.client_side_validation and recent_launch_failures is None:  # noqa: E501
+            raise ValueError("Invalid value for `recent_launch_failures`, must not be `None`")  # noqa: E501
+
+        self._recent_launch_failures = recent_launch_failures
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}

anyscale/client/openapi_client/models/tool.py

@@ -30,8 +30,9 @@ class Tool(object):
     """
     SERVICE_DASHBOARD = "service_dashboard"
     SERVE_DEPLOYMENT_DASHBOARD = "serve_deployment_dashboard"
+    SERVICE_ALERTING_DASHBOARD = "service_alerting_dashboard"
 
-    allowable_values = [SERVICE_DASHBOARD, SERVE_DEPLOYMENT_DASHBOARD]  # noqa: E501
+    allowable_values = [SERVICE_DASHBOARD, SERVE_DEPLOYMENT_DASHBOARD, SERVICE_ALERTING_DASHBOARD]  # noqa: E501
 
     """
     Attributes:

anyscale/client/openapi_client/models/workspace_dataplane_proxied_artifacts.py

@@ -36,17 +36,19 @@ class WorkspaceDataplaneProxiedArtifacts(object):
         'requirements': 'str',
         'skip_packages_tracking': 'str',
         'environment_variables': 'list[str]',
-        'dockerfile': 'str'
+        'dockerfile': 'str',
+        'dockerfile_draft': 'str'
     }
 
     attribute_map = {
         'requirements': 'requirements',
         'skip_packages_tracking': 'skip_packages_tracking',
         'environment_variables': 'environment_variables',
-        'dockerfile': 'dockerfile'
+        'dockerfile': 'dockerfile',
+        'dockerfile_draft': 'dockerfile_draft'
     }
 
-    def __init__(self, requirements=None, skip_packages_tracking=None, environment_variables=None, dockerfile=None, local_vars_configuration=None):  # noqa: E501
+    def __init__(self, requirements=None, skip_packages_tracking=None, environment_variables=None, dockerfile=None, dockerfile_draft=None, local_vars_configuration=None):  # noqa: E501
         """WorkspaceDataplaneProxiedArtifacts - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration()
@@ -56,6 +58,7 @@ class WorkspaceDataplaneProxiedArtifacts(object):
         self._skip_packages_tracking = None
         self._environment_variables = None
         self._dockerfile = None
+        self._dockerfile_draft = None
         self.discriminator = None
 
         if requirements is not None:
@@ -66,6 +69,8 @@ class WorkspaceDataplaneProxiedArtifacts(object):
             self.environment_variables = environment_variables
         if dockerfile is not None:
             self.dockerfile = dockerfile
+        if dockerfile_draft is not None:
+            self.dockerfile_draft = dockerfile_draft
 
     @property
     def requirements(self):
@@ -159,6 +164,29 @@ class WorkspaceDataplaneProxiedArtifacts(object):
 
         self._dockerfile = dockerfile
 
+    @property
+    def dockerfile_draft(self):
+        """Gets the dockerfile_draft of this WorkspaceDataplaneProxiedArtifacts.  # noqa: E501
+
+        The Dockerfile.draft of the workspace.  # noqa: E501
+
+        :return: The dockerfile_draft of this WorkspaceDataplaneProxiedArtifacts.  # noqa: E501
+        :rtype: str
+        """
+        return self._dockerfile_draft
+
+    @dockerfile_draft.setter
+    def dockerfile_draft(self, dockerfile_draft):
+        """Sets the dockerfile_draft of this WorkspaceDataplaneProxiedArtifacts.
+
+        The Dockerfile.draft of the workspace.  # noqa: E501
+
+        :param dockerfile_draft: The dockerfile_draft of this WorkspaceDataplaneProxiedArtifacts.  # noqa: E501
+        :type: str
+        """
+
+        self._dockerfile_draft = dockerfile_draft
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}

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/cloud/_private/cloud_sdk.py

@@ -1,10 +1,16 @@
-from typing import List
+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 CreateCloudCollaborator
+from anyscale.cloud.models import (
+    Cloud,
+    CloudProvider,
+    ComputeStack,
+    CreateCloudCollaborator,
+)
 
 
 class PrivateCloudSDK(BaseSDK):
@@ -23,3 +29,54 @@ class PrivateCloudSDK(BaseSDK):
                 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/cloud/commands.py

@@ -1,7 +1,7 @@
-from typing import List
+from typing import List, Optional
 
 from anyscale._private.sdk import sdk_command
-from anyscale.cloud._private.cloud_sdk import PrivateCloudSDK
+from anyscale.cloud._private.cloud_sdk import Cloud, PrivateCloudSDK
 from anyscale.cloud.models import CreateCloudCollaborator
 
 
@@ -39,7 +39,75 @@ _ADD_COLLABORATORS_ARG_DOCSTRINGS = {
     arg_docstrings=_ADD_COLLABORATORS_ARG_DOCSTRINGS,
 )
 def add_collaborators(
-    cloud: str, collaborators: List[CreateCloudCollaborator], *, _sdk: PrivateCloudSDK
+    cloud: str, collaborators: List[CreateCloudCollaborator], *, _sdk: PrivateCloudSDK,
 ) -> 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 _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/cloud/models.py

@@ -1,5 +1,6 @@
 from dataclasses import dataclass, field
-from typing import Any, Dict, List
+from datetime import datetime
+from typing import Any, Dict, List, Optional, Union
 
 from anyscale._private.models import ModelBase, ModelEnum
 
@@ -11,7 +12,7 @@ class CloudPermissionLevel(ModelEnum):
     __docstrings__ = {
         WRITE: "Write permission level for the cloud",
         READONLY: "Readonly permission level for the cloud",
-    }
+    }  # type: ignore
 
 
 @dataclass(frozen=True)
@@ -43,7 +44,7 @@ create_cloud_collaborator = CreateCloudCollaborator(
         self, permission_level: CloudPermissionLevel
     ) -> CloudPermissionLevel:
         if isinstance(permission_level, str):
-            return CloudPermissionLevel.validate(permission_level)
+            return CloudPermissionLevel.validate(permission_level)  # type: ignore
         elif isinstance(permission_level, CloudPermissionLevel):
             return permission_level
         else:
@@ -89,3 +90,120 @@ create_cloud_collaborators = CreateCloudCollaborators(
     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/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}")

anyscale/commands/command_examples.py

@@ -561,6 +561,28 @@ collaborators:
     permission_level: "readonly"
 """
 
+CLOUD_GET_CLOUD_EXAMPLE = """\
+$ anyscale cloud get --name cloud_name
+name: anyscale_v2_default_cloud
+id: cld_123
+provider: AWS
+region: us-west-2
+created_at: 2022-10-18 05:12:13.335803+00:00
+is_default: false
+compute_stack: VM
+"""
+
+CLOUD_GET_DEFAULT_CLOUD_EXAMPLE = """\
+$ anyscale cloud get-default
+name: anyscale_v2_default_cloud
+id: cld_abc
+provider: AWS
+region: us-west-2
+created_at: 2022-10-18 05:12:13.335803+00:00
+is_default: true
+compute_stack: VM
+"""
+
 SERVICE_ARCHIVE_EXAMPLE = """\
 $ anyscale service archive --name my_service
 """