anyscale 0.25.1__py3-none-any.whl → 0.25.3__py3-none-any.whl

anyscale/__init__.py

@@ -31,6 +31,7 @@ from anyscale import (
     resource_quota,
     schedule,
     service,
+    service_account,
     user,
 )
 from anyscale._private.anyscale_client import AnyscaleClient, AnyscaleClientInterface
@@ -52,6 +53,7 @@ from anyscale.resource_quota import ResourceQuotaSDK
 from anyscale.schedule import ScheduleSDK
 from anyscale.sdk.anyscale_client.sdk import AnyscaleSDK
 from anyscale.service import ServiceSDK
+from anyscale.service_account import ServiceAccountSDK
 from anyscale.user import UserSDK
 from anyscale.workspace import WorkspaceSDK
 
@@ -128,6 +130,7 @@ class Anyscale:
         )
         self._project_sdk = ProjectSDK(client=self._anyscale_client)
         self._resource_quota_sdk = ResourceQuotaSDK(client=self._anyscale_client)
+        self._service_account_sdk = ServiceAccountSDK(client=self._anyscale_client)
         self._user_sdk = UserSDK(client=self._anyscale_client)
         self._workspace_sdk = WorkspaceSDK(client=self._anyscale_client)
 
@@ -162,6 +165,9 @@ class Anyscale:
         obj._project_sdk = ProjectSDK(  # noqa: SLF001
             client=client, logger=logger, timer=timer
         )
+        obj._service_account_sdk = ServiceAccountSDK(  # noqa: SLF001
+            client=client, logger=logger, timer=timer
+        )
         obj._user_sdk = UserSDK(  # noqa: SLF001
             client=client, logger=logger, timer=timer
         )
@@ -217,6 +223,10 @@ class Anyscale:
     def resource_quota(self) -> ResourceQuotaSDK:  # noqa: F811
         return self._resource_quota_sdk
 
+    @property
+    def service_account(self) -> ServiceAccountSDK:  # noqa: F811
+        return self._service_account_sdk
+
     @property
     def user(self) -> UserSDK:  # noqa: F811
         return self._user_sdk

anyscale/_private/anyscale_client/anyscale_client.py

@@ -36,6 +36,8 @@ from anyscale.client.openapi_client.api.default_api import DefaultApi as Interna
 from anyscale.client.openapi_client.models import (
     AdminCreatedUser,
     AdminCreateUser,
+    AnyscaleServiceAccount,
+    ApiKeyParameters,
     ArchiveStatus,
     Cloud,
     CloudDataBucketAccessMode,
@@ -69,6 +71,7 @@ from anyscale.client.openapi_client.models import (
     OrganizationInvitation,
     ResourceQuota,
     ResourceQuotaStatus,
+    ServerSessionToken,
     SessionSshKey,
     StartSessionOptions,
     StopSessionOptions,
@@ -1092,6 +1095,11 @@ class AnyscaleClient(AnyscaleClientInterface):
         result: ServiceModel = self._external_api_client.terminate_service(service_id)
         return result
 
+    @handle_api_exceptions
+    def archive_service(self, service_id: str) -> ServiceModel:
+        result: ServiceModel = self._external_api_client.archive_service(service_id)
+        return result
+
     @handle_api_exceptions
     def submit_job(self, model: CreateInternalProductionJob) -> InternalProductionJob:
         job: InternalProductionJob = self._internal_api_client.create_job_api_v2_decorated_ha_jobs_create_post(
@@ -1860,6 +1868,20 @@ class AnyscaleClient(AnyscaleClientInterface):
 
         return filepath
 
+    @handle_api_exceptions
+    def create_api_key(
+        self, duration: float, user_id: Optional[str]
+    ) -> ServerSessionToken:
+        return self._internal_api_client.create_api_key_api_v2_users_create_api_key_post(
+            ApiKeyParameters(user_id=user_id, duration=duration)
+        ).result
+
+    @handle_api_exceptions
+    def rotate_api_key(self, user_id: str) -> None:
+        self._internal_api_client.rotate_api_key_for_user_api_v2_organization_collaborators_rotate_api_key_for_user_user_id_post(
+            user_id
+        )
+
     @handle_api_exceptions
     def admin_batch_create_users(
         self, admin_create_users: List[AdminCreateUser]
@@ -1915,20 +1937,29 @@ class AnyscaleClient(AnyscaleClientInterface):
         ).result
 
     @handle_api_exceptions
-    def get_organization_collaborator(self, email: str) -> OrganizationCollaborator:
+    def get_organization_collaborators(
+        self,
+        email: Optional[str] = None,
+        name: Optional[str] = None,
+        is_service_account: Optional[bool] = None,
+    ) -> List[OrganizationCollaborator]:
         results = self._internal_api_client.list_organization_collaborators_api_v2_organization_collaborators_get(
-            email=email
+            email=email, name=name, is_service_account=is_service_account
         ).results
 
-        if len(results) == 0:
-            raise ValueError(f"User with email '{email}' not found.")
+        return results
 
-        if len(results) > 1:
-            raise ValueError(
-                f"Multiple users found for email '{email}'. Please contact Anyscale support."
-            )
+    @handle_api_exceptions
+    def delete_organization_collaborator(self, identity_id: str) -> None:
+        self._internal_api_client.remove_organization_collaborator_api_v2_organization_collaborators_identity_id_delete(
+            identity_id
+        )
 
-        return results[0]
+    @handle_api_exceptions
+    def create_service_account(self, name: str) -> AnyscaleServiceAccount:
+        return self._internal_api_client.create_service_account_api_v2_users_service_accounts_post(
+            name
+        ).result
 
     @handle_api_exceptions
     def create_resource_quota(

anyscale/_private/anyscale_client/common.py

@@ -6,6 +6,7 @@ from anyscale._private.models.image_uri import ImageURI
 from anyscale.client.openapi_client.models import (
     AdminCreatedUser,
     AdminCreateUser,
+    AnyscaleServiceAccount,
     Cloud,
     ComputeTemplateConfig,
     CreateCloudCollaborator,
@@ -21,6 +22,7 @@ from anyscale.client.openapi_client.models import (
     OrganizationInvitation,
     Project,
     ResourceQuota,
+    ServerSessionToken,
     WorkspaceDataplaneProxiedArtifacts,
 )
 from anyscale.client.openapi_client.models.create_schedule import CreateSchedule
@@ -47,7 +49,7 @@ from anyscale.utils.workspace_notification import WorkspaceNotification
 # Maybe just make it part of the release process to update it, or fetch the
 # default builds and get the latest one. The best thing to do is probably
 # to populate this in the backend.
-DEFAULT_RAY_VERSION = "2.40.0"  # RAY_RELEASE_UPDATE: update to latest version.
+DEFAULT_RAY_VERSION = "2.41.0"  # RAY_RELEASE_UPDATE: update to latest version.
 DEFAULT_PYTHON_VERSION = "py311"
 RUNTIME_ENV_PACKAGE_FORMAT = "pkg_{content_hash}.zip"
 
@@ -351,6 +353,11 @@ class AnyscaleClientInterface(ABC):
         """Mark the service to be terminated asynchronously."""
         raise NotImplementedError
 
+    @abstractmethod
+    def archive_service(self, service_id: str):
+        """Mark the service to be archived asynchronously."""
+        raise NotImplementedError
+
     @abstractmethod
     def submit_job(self, model: CreateInternalProductionJob) -> InternalProductionJob:
         """Submit the job to run."""
@@ -614,6 +621,18 @@ class AnyscaleClientInterface(ABC):
         """Download the aggregated instance usage csv."""
         raise NotImplementedError
 
+    @abstractmethod
+    def create_api_key(
+        self, duration: float, user_id: Optional[str]
+    ) -> ServerSessionToken:
+        """Create a new API key."""
+        raise NotImplementedError
+
+    @abstractmethod
+    def rotate_api_key(self, user_id: str) -> None:
+        """Rotate the API key for user."""
+        raise NotImplementedError
+
     @abstractmethod
     def admin_batch_create_users(
         self, admin_create_users: List[AdminCreateUser]
@@ -639,8 +658,23 @@ class AnyscaleClientInterface(ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def get_organization_collaborator(self, email: str) -> OrganizationCollaborator:
-        """Get organization collaborator."""
+    def get_organization_collaborators(
+        self,
+        email: Optional[str] = None,
+        name: Optional[str] = None,
+        is_service_account: Optional[bool] = None,
+    ) -> List[OrganizationCollaborator]:
+        """Get organization collaborators."""
+        raise NotImplementedError
+
+    @abstractmethod
+    def delete_organization_collaborator(self, identity_id: str) -> None:
+        """Delete organization collaborator."""
+        raise NotImplementedError
+
+    @abstractmethod
+    def create_service_account(self, name: str) -> AnyscaleServiceAccount:
+        """Create a service account."""
         raise NotImplementedError
 
     @abstractmethod

anyscale/_private/anyscale_client/fake_anyscale_client.py

@@ -16,6 +16,7 @@ from anyscale.cli_logger import BlockLogger
 from anyscale.client.openapi_client.models import (
     AdminCreatedUser,
     AdminCreateUser,
+    AnyscaleServiceAccount,
     Cloud,
     CloudProviders,
     ComputeTemplateConfig,
@@ -41,6 +42,7 @@ from anyscale.client.openapi_client.models import (
     ProductionJobStateTransition,
     Project,
     ResourceQuota,
+    ServerSessionToken,
     WorkspaceDataplaneProxiedArtifacts,
 )
 from anyscale.client.openapi_client.models.create_schedule import CreateSchedule
@@ -142,6 +144,7 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
         self._workspace_cluster: Optional[Cluster] = None
         self._workspace_dependency_tracking_enabled: bool = False
         self._services: Dict[str, ServiceModel] = {}
+        self._archived_services: Dict[str, ServiceModel] = {}
         self._jobs: Dict[str, ProductionJob] = {}
         self._job_runs: Dict[str, List[APIJobRun]] = defaultdict(list)
         self._project_to_id: Dict[Optional[str] : Dict[Optional[str], str]] = {}
@@ -165,6 +168,8 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
         self._workspaces_env_vars: Dict[str, Dict[str, str]] = {}
         self._clusters_headnode_ip: Dict[str, str] = {}
         self._clusters_ssh_key: Dict[str, SessionSshKey] = {}
+        self._api_keys: Dict[str, List[str]] = defaultdict(list)
+        self._organization_collaborators: List[OrganizationCollaborator] = []
         self._organization_invitations: Dict[str, OrganizationInvitation] = {}
         self._resource_quotas: Dict[str, ResourceQuota] = {}
 
@@ -759,6 +764,16 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
                 service_id
             ].primary_version.current_state = ServiceVersionState.TERMINATED
 
+    @property
+    def archived_services(self) -> Dict[str, ServiceModel]:
+        return self._archived_services
+
+    def archive_service(self, service_id: str):
+        self._archived_services[service_id] = self._services.pop(service_id)
+
+    def is_archived_service(self, service_id: str) -> bool:
+        return service_id in self._archived_services
+
     @property
     def submitted_job(self) -> Optional[CreateInternalProductionJob]:
         return self._submitted_job
@@ -1139,6 +1154,20 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
 
         return filepath
 
+    def create_api_key(
+        self, duration: float, user_id: Optional[str]  # noqa: ARG002
+    ) -> ServerSessionToken:
+        api_key = f"{uuid.uuid4()!s}"
+        api_keys = self._api_keys.get(user_id or "usr_1", [])
+        self._api_keys[user_id or "usr_1"] = api_keys + [api_key]
+
+        return ServerSessionToken(server_session_id=api_key)
+
+    def rotate_api_key(self, user_id: str) -> None:
+        if user_id not in self._api_keys:
+            raise ValueError(f"User '{user_id}' not found.")
+        self._api_keys[user_id] = [f"{uuid.uuid4()!s}"]
+
     def admin_batch_create_users(
         self, admin_create_users: List[AdminCreateUser]
     ) -> List[AdminCreatedUser]:
@@ -1195,14 +1224,59 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
 
         return self._organization_invitations.pop(email)
 
-    def get_organization_collaborator(self, email):
-        return OrganizationCollaborator(
-            id="identity_1",
+    def get_organization_collaborators(
+        self,
+        email: Optional[str] = None,
+        name: Optional[str] = None,
+        is_service_account: Optional[bool] = None,  # noqa: ARG002
+    ) -> List[OrganizationCollaborator]:
+        # Since organization collaborator doesn't include whether it's a service account or not, we'll just return all
+        results = []
+        for organization_collaborator in self._organization_collaborators:
+            if email and organization_collaborator.email != email:
+                continue
+            if name and organization_collaborator.name != name:
+                continue
+
+            results.append(organization_collaborator)
+
+        return results
+
+    def delete_organization_collaborator(self, identity_id: str) -> None:
+        for organization_collaborator in self._organization_collaborators:
+            if organization_collaborator.id == identity_id:
+                self._organization_collaborators.remove(organization_collaborator)
+                return
+
+        raise ValueError(
+            f"Organization collaborator with id '{identity_id}' not found."
+        )
+
+    def create_service_account(self, name) -> AnyscaleServiceAccount:
+        for organization_collaborator in self._organization_collaborators:
+            if organization_collaborator.name == name:
+                raise ValueError(f"Service account with name '{name}' already exists.")
+
+        identity_id = f"id_{uuid.uuid4()!s}"
+        user_id = f"usr_{uuid.uuid4()!s}"
+        organization_collaborator = OrganizationCollaborator(
             permission_level=OrganizationPermissionLevel.COLLABORATOR,
-            name="Test User",
+            id=identity_id,
+            name=name,
+            email=f"{name}@service-account.com",
+            user_id=user_id,
             created_at=datetime.utcnow(),
-            email=email,
-            user_id="usr_1",
+        )
+
+        self._organization_collaborators.append((organization_collaborator))
+
+        return AnyscaleServiceAccount(
+            user_id=organization_collaborator.user_id,
+            name=organization_collaborator.name,
+            organization_id="org_1",
+            email=organization_collaborator.email,
+            permission_level=organization_collaborator.permission_level,
+            created_at=organization_collaborator.created_at,
         )
 
     def create_resource_quota(

anyscale/_private/docgen/__main__.py

@@ -76,6 +76,7 @@ from anyscale.service.models import (
     ServiceVersionStatus,
     TracingConfig,
 )
+from anyscale.service_account.models import OrganizationPermissionLevel, ServiceAccount
 from anyscale.user.models import AdminCreatedUser, AdminCreateUser
 from anyscale.workspace.models import WorkspaceConfig
 
@@ -356,8 +357,14 @@ ALL_MODULES = [
             service_account_commands.rotate_api_keys,
         ],
         sdk_prefix="anyscale.service_account",
-        sdk_commands=[],
-        models=[],
+        sdk_commands=[
+            anyscale.service_account.create,
+            anyscale.service_account.create_api_key,
+            anyscale.service_account.list,
+            anyscale.service_account.delete,
+            anyscale.service_account.rotate_api_keys,
+        ],
+        models=[ServiceAccount, OrganizationPermissionLevel],
     ),
     Module(
         title="Image",

anyscale/_private/docgen/api.md

@@ -949,6 +949,18 @@ Returns [ProductionjobResponse](./models.md#productionjobresponse)
 
 ## Services
 
+### archive_service
+
+Archives a Service. It is a no-op if already archived.
+
+Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ `service_id` | str|  | Defaults to null
+
+Returns void (empty response body)
+
 ### get_service
 
 Get a Service
@@ -972,6 +984,7 @@ Name | Type | Description  | Notes
  `project_id` | optional str| project_id to filter by | Defaults to null
  `name` | optional str| name to filter by | Defaults to null
  `state_filter` | [List[ServiceEventCurrentState]](./models.md#serviceeventcurrentstate)| A list of Service states to filter by | Defaults to []
+ `archive_status` | [ArchiveStatus](./models.md#archivestatus)| The archive status to filter by. Defaults to unarchived. | Defaults to null
  `creator_id` | optional str| creator_id to filter by | Defaults to null
  `cloud_id` | optional str| cloud_id to filter by | Defaults to null
  `sort_field` | [ServiceSortField](./models.md#servicesortfield)| If absent, the default sorting order is 1. status (active first).2. Last updated at (desc). 3. Name (asc). | Defaults to null