anyscale 0.24.87__py3-none-any.whl → 0.24.91__py3-none-any.whl

anyscale/client/openapi_client/models/usage_by_user.py

@@ -36,17 +36,19 @@ class UsageByUser(object):
         'anyscale_credits': 'float',
         'date': 'date',
         'user_id': 'str',
-        'user_email': 'str'
+        'user_email': 'str',
+        'user_name': 'str'
     }
 
     attribute_map = {
         'anyscale_credits': 'anyscale_credits',
         'date': 'date',
         'user_id': 'user_id',
-        'user_email': 'user_email'
+        'user_email': 'user_email',
+        'user_name': 'user_name'
     }
 
-    def __init__(self, anyscale_credits=None, date=None, user_id=None, user_email=None, local_vars_configuration=None):  # noqa: E501
+    def __init__(self, anyscale_credits=None, date=None, user_id=None, user_email=None, user_name=None, local_vars_configuration=None):  # noqa: E501
         """UsageByUser - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration()
@@ -56,6 +58,7 @@ class UsageByUser(object):
         self._date = None
         self._user_id = None
         self._user_email = None
+        self._user_name = None
         self.discriminator = None
 
         self.anyscale_credits = anyscale_credits
@@ -63,6 +66,7 @@ class UsageByUser(object):
             self.date = date
         self.user_id = user_id
         self.user_email = user_email
+        self.user_name = user_name
 
     @property
     def anyscale_credits(self):
@@ -154,6 +158,29 @@ class UsageByUser(object):
 
         self._user_email = user_email
 
+    @property
+    def user_name(self):
+        """Gets the user_name of this UsageByUser.  # noqa: E501
+
+
+        :return: The user_name of this UsageByUser.  # noqa: E501
+        :rtype: str
+        """
+        return self._user_name
+
+    @user_name.setter
+    def user_name(self, user_name):
+        """Sets the user_name of this UsageByUser.
+
+
+        :param user_name: The user_name of this UsageByUser.  # noqa: E501
+        :type: str
+        """
+        if self.local_vars_configuration.client_side_validation and user_name is None:  # noqa: E501
+            raise ValueError("Invalid value for `user_name`, must not be `None`")  # noqa: E501
+
+        self._user_name = user_name
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}

anyscale/client/openapi_client/models/workload_info.py

@@ -0,0 +1,210 @@
+# coding: utf-8
+
+"""
+    Managed Ray API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from openapi_client.configuration import Configuration
+
+
+class WorkloadInfo(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+        'workload_name': 'str',
+        'workload_type': 'str',
+        'workload_start_time': 'datetime',
+        'workload_cloud': 'str'
+    }
+
+    attribute_map = {
+        'workload_name': 'workload_name',
+        'workload_type': 'workload_type',
+        'workload_start_time': 'workload_start_time',
+        'workload_cloud': 'workload_cloud'
+    }
+
+    def __init__(self, workload_name=None, workload_type=None, workload_start_time=None, workload_cloud=None, local_vars_configuration=None):  # noqa: E501
+        """WorkloadInfo - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._workload_name = None
+        self._workload_type = None
+        self._workload_start_time = None
+        self._workload_cloud = None
+        self.discriminator = None
+
+        self.workload_name = workload_name
+        self.workload_type = workload_type
+        self.workload_start_time = workload_start_time
+        self.workload_cloud = workload_cloud
+
+    @property
+    def workload_name(self):
+        """Gets the workload_name of this WorkloadInfo.  # noqa: E501
+
+        The name of the workload.  # noqa: E501
+
+        :return: The workload_name of this WorkloadInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._workload_name
+
+    @workload_name.setter
+    def workload_name(self, workload_name):
+        """Sets the workload_name of this WorkloadInfo.
+
+        The name of the workload.  # noqa: E501
+
+        :param workload_name: The workload_name of this WorkloadInfo.  # noqa: E501
+        :type: str
+        """
+        if self.local_vars_configuration.client_side_validation and workload_name is None:  # noqa: E501
+            raise ValueError("Invalid value for `workload_name`, must not be `None`")  # noqa: E501
+
+        self._workload_name = workload_name
+
+    @property
+    def workload_type(self):
+        """Gets the workload_type of this WorkloadInfo.  # noqa: E501
+
+        The type of the workload.  # noqa: E501
+
+        :return: The workload_type of this WorkloadInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._workload_type
+
+    @workload_type.setter
+    def workload_type(self, workload_type):
+        """Sets the workload_type of this WorkloadInfo.
+
+        The type of the workload.  # noqa: E501
+
+        :param workload_type: The workload_type of this WorkloadInfo.  # noqa: E501
+        :type: str
+        """
+        if self.local_vars_configuration.client_side_validation and workload_type is None:  # noqa: E501
+            raise ValueError("Invalid value for `workload_type`, must not be `None`")  # noqa: E501
+
+        self._workload_type = workload_type
+
+    @property
+    def workload_start_time(self):
+        """Gets the workload_start_time of this WorkloadInfo.  # noqa: E501
+
+        The start time of the workload.  # noqa: E501
+
+        :return: The workload_start_time of this WorkloadInfo.  # noqa: E501
+        :rtype: datetime
+        """
+        return self._workload_start_time
+
+    @workload_start_time.setter
+    def workload_start_time(self, workload_start_time):
+        """Sets the workload_start_time of this WorkloadInfo.
+
+        The start time of the workload.  # noqa: E501
+
+        :param workload_start_time: The workload_start_time of this WorkloadInfo.  # noqa: E501
+        :type: datetime
+        """
+        if self.local_vars_configuration.client_side_validation and workload_start_time is None:  # noqa: E501
+            raise ValueError("Invalid value for `workload_start_time`, must not be `None`")  # noqa: E501
+
+        self._workload_start_time = workload_start_time
+
+    @property
+    def workload_cloud(self):
+        """Gets the workload_cloud of this WorkloadInfo.  # noqa: E501
+
+        The cloud of the workload.  # noqa: E501
+
+        :return: The workload_cloud of this WorkloadInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._workload_cloud
+
+    @workload_cloud.setter
+    def workload_cloud(self, workload_cloud):
+        """Sets the workload_cloud of this WorkloadInfo.
+
+        The cloud of the workload.  # noqa: E501
+
+        :param workload_cloud: The workload_cloud of this WorkloadInfo.  # noqa: E501
+        :type: str
+        """
+        if self.local_vars_configuration.client_side_validation and workload_cloud is None:  # noqa: E501
+            raise ValueError("Invalid value for `workload_cloud`, must not be `None`")  # noqa: E501
+
+        self._workload_cloud = workload_cloud
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, WorkloadInfo):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, WorkloadInfo):
+            return True
+
+        return self.to_dict() != other.to_dict()

anyscale/cloud/__init__.py

@@ -0,0 +1,83 @@
+import inspect
+import sys
+from types import ModuleType
+from typing import Any, Dict, List, Optional
+
+from anyscale._private.anyscale_client import AnyscaleClientInterface
+from anyscale._private.sdk import sdk_docs
+from anyscale._private.sdk.base_sdk import Timer
+from anyscale.cli_logger import BlockLogger
+from anyscale.cloud._private.cloud_sdk import PrivateCloudSDK
+from anyscale.cloud.commands import (
+    _ADD_COLLABORATORS_ARG_DOCSTRINGS,
+    _ADD_COLLABORATORS_EXAMPLE,
+    add_collaborators,
+)
+from anyscale.cloud.models import CreateCloudCollaborator
+from anyscale.connect import ClientBuilder
+
+
+class CloudSDK:
+    def __init__(
+        self,
+        *,
+        client: Optional[AnyscaleClientInterface] = None,
+        logger: Optional[BlockLogger] = None,
+        timer: Optional[Timer] = None,
+    ):
+        self._private_sdk = PrivateCloudSDK(client=client, logger=logger, timer=timer)
+
+    @sdk_docs(
+        doc_py_example=_ADD_COLLABORATORS_EXAMPLE,
+        arg_docstrings=_ADD_COLLABORATORS_ARG_DOCSTRINGS,
+    )
+    def add_collaborators(  # noqa: F811
+        self, cloud: str, collaborators: List[CreateCloudCollaborator]
+    ) -> str:
+        """Batch add collaborators to a cloud."""
+        return self._private_sdk.add_collaborators(cloud, collaborators)
+
+
+# Note: indentation here matches that of connect.py::ClientBuilder.
+BUILDER_HELP_FOOTER = """
+        See ``anyscale.ClientBuilder`` for full documentation of
+        this experimental feature."""
+
+
+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.
+    """
+
+    def __init__(self):
+        # Expose attributes from the SDK.
+        self.CloudSDK = CloudSDK
+        self.add_collaborators = add_collaborators
+
+        # Expose Anyscale connect
+        self.new_builder = self._new_builder()
+
+    # This code is copied from frontend/cli/anyscale/__init__.py.
+    def _new_builder(self) -> Any:
+        target = ClientBuilder.cloud
+
+        def new_session_builder(*a: List[Any], **kw: Dict[str, Any]) -> Any:
+            builder = ClientBuilder()
+            return target(builder, *a, **kw)  # type: ignore
+
+        new_session_builder.__name__ = "cloud"
+        new_session_builder.__doc__ = target.__doc__ + BUILDER_HELP_FOOTER  # type: ignore
+        new_session_builder.__signature__ = inspect.signature(target)  # type: ignore
+
+        return new_session_builder
+
+    def __call__(self, *args, **kwargs):
+        """
+        Define the behavior when `anyscale.cloud` is called for Anyscale connect.
+        """
+        return self.new_builder(*args, **kwargs)
+
+
+sys.modules[__name__] = CloudModule()

anyscale/cloud/_private/cloud_sdk.py

@@ -0,0 +1,25 @@
+from typing import List
+
+from anyscale._private.sdk.base_sdk import BaseSDK
+from anyscale.client.openapi_client.models import (
+    CreateCloudCollaborator as CreateCloudCollaboratorModel,
+)
+from anyscale.cloud.models import 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
+            ],
+        )

anyscale/cloud/commands.py

@@ -0,0 +1,45 @@
+from typing import List
+
+from anyscale._private.sdk import sdk_command
+from anyscale.cloud._private.cloud_sdk import 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."""
+    return _sdk.add_collaborators(cloud, collaborators)

anyscale/cloud/models.py

@@ -0,0 +1,91 @@
+from dataclasses import dataclass, field
+from typing import Any, Dict, List
+
+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",
+    }
+
+
+@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)
+        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.")

anyscale/cluster_compute.py

@@ -4,7 +4,7 @@ from typing import Optional, Tuple
 from anyscale.authenticate import get_auth_api_client
 from anyscale.cli_logger import BlockLogger
 from anyscale.client.openapi_client.api.default_api import DefaultApi
-from anyscale.cloud import get_cloud_id_and_name, get_last_used_cloud
+from anyscale.cloud_utils import get_cloud_id_and_name, get_last_used_cloud
 from anyscale.sdk.anyscale_client import (
     ArchiveStatus,
     ComputeTemplateConfig,

anyscale/commands/aggregated_instance_usage_commands.py

@@ -26,13 +26,13 @@ def aggregated_instance_usage_cli() -> None:
     "--start-date",
     required=True,
     type=str,
-    help="The start date of the aggregated instance usage report (inclusive). Format: YYYY-MM-DD",
+    help="The start date (inclusive) of the aggregated instance usage report. Format: YYYY-MM-DD",
 )
 @click.option(
     "--end-date",
     required=True,
     type=str,
-    help="The end date of the aggregated instance usage report (inclusive). Format: YYYY-MM-DD",
+    help="The end date (inclusive) of the aggregated instance usage report. Format: YYYY-MM-DD",
 )
 @click.option(
     "--cloud",
@@ -50,7 +50,7 @@ def aggregated_instance_usage_cli() -> None:
     "--directory",
     required=False,
     type=str,
-    help="The directory to save the CSV file to. Default is the current directory",
+    help="The directory to save the CSV file to. Default is the current directory.",
 )
 @click.option(
     "--hide-progress-bar",
@@ -67,7 +67,7 @@ def download_csv(
     hide_progress_bar: Optional[bool] = False,
 ) -> None:
     """
-    Download an aggregated instance usage report as a zipped csv to the provided directory.
+    Download an aggregated instance usage report as a zipped CSV to the provided directory.
     """
     log.info("Downloading aggregated instance usage CSV...")
     try:

anyscale/commands/cloud_commands.py

@@ -3,11 +3,13 @@ from typing import List, Optional
 
 import click
 
+import anyscale
 from anyscale.cli_logger import BlockLogger
 from anyscale.client.openapi_client.models import ClusterManagementStackVersions
 from anyscale.client.openapi_client.models.compute_stack import ComputeStack
-from anyscale.commands import cloud_commands_util
-from anyscale.commands.util import OptionPromptNull
+from anyscale.cloud.models import CreateCloudCollaborator, CreateCloudCollaborators
+from anyscale.commands import cloud_commands_util, command_examples
+from anyscale.commands.util import AnyscaleCommand, OptionPromptNull
 from anyscale.controllers.cloud_controller import CloudController
 from anyscale.util import validate_non_negative_arg
 
@@ -1017,3 +1019,37 @@ def cloud_edit(  # noqa: PLR0913
         raise click.ClickException(
             "Please provide at least one of the following arguments: --aws-s3-id, --aws-efs-id, --aws-efs-mount-target-ip, --memorydb-cluster-id, --gcp-filestore-instance-id, --gcp-filestore-location, --gcp-cloud-storage-bucket-name, --memorystore-instance-name, --enable-auto-add-user, --disable-auto-add-user."
         )
+
+
+@cloud_cli.command(
+    name="add-collaborators",
+    help="Add collaborators to the cloud.",
+    cls=AnyscaleCommand,
+    example=command_examples.CLOUD_ADD_COLLABORATORS_EXAMPLE,
+)
+@click.option(
+    "--cloud", "-c", help="Name of the cloud to add collaborators to.", required=True
+)
+@click.option(
+    "--users-file",
+    help="Path to a YAML file containing a list of users to add to the cloud.",
+    required=True,
+)
+def add_collaborators(cloud: str, users_file: str,) -> None:
+    collaborators = CreateCloudCollaborators.from_yaml(users_file)
+
+    try:
+        anyscale.cloud.add_collaborators(
+            cloud=cloud,
+            collaborators=[
+                CreateCloudCollaborator(**collaborator)
+                for collaborator in collaborators.collaborators
+            ],
+        )
+    except ValueError as e:
+        log.error(f"Error adding collaborators to cloud: {e}")
+        return
+
+    log.info(
+        f"Successfully added {len(collaborators.collaborators)} collaborators to cloud {cloud}."
+    )