anyscale 0.24.88__py3-none-any.whl → 0.25.5__py3-none-any.whl

anyscale/_private/anyscale_client/fake_anyscale_client.py

@@ -16,10 +16,15 @@ from anyscale.cli_logger import BlockLogger
 from anyscale.client.openapi_client.models import (
     AdminCreatedUser,
     AdminCreateUser,
+    AnyscaleServiceAccount,
     Cloud,
+    CloudProviders,
     ComputeTemplateConfig,
+    CreateCloudCollaborator,
     CreateExperimentalWorkspace,
     CreateInternalProductionJob,
+    CreateResourceQuota,
+    CreateUserProjectCollaborator,
     DecoratedComputeTemplate,
     DeletedPlatformFineTunedModel,
     ExperimentalWorkspace,
@@ -28,9 +33,16 @@ from anyscale.client.openapi_client.models import (
     HaJobGoalStates,
     HaJobStates,
     InternalProductionJob,
+    MiniCloud,
+    MiniUser,
+    OrganizationCollaborator,
+    OrganizationInvitation,
+    OrganizationPermissionLevel,
     ProductionJob,
     ProductionJobStateTransition,
     Project,
+    ResourceQuota,
+    ServerSessionToken,
     WorkspaceDataplaneProxiedArtifacts,
 )
 from anyscale.client.openapi_client.models.create_schedule import CreateSchedule
@@ -132,9 +144,11 @@ 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]] = {}
+        self._project_collaborators: Dict[str, List[CreateUserProjectCollaborator]] = {}
         self._rolled_out_model: Optional[ApplyServiceModel] = None
         self._sent_workspace_notifications: List[WorkspaceNotification] = []
         self._rolled_back_service: Optional[Tuple[str, Optional[int]]] = None
@@ -154,6 +168,10 @@ 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] = {}
 
         # Cloud ID -> Cloud.
         self._clouds: Dict[str, Cloud] = {
@@ -164,6 +182,9 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
             ),
         }
 
+        # Cloud ID -> collaborators
+        self._cloud_collaborators: Dict[str, List[CreateCloudCollaborator]] = {}
+
         # Cloud ID -> default ClusterCompute.
         compute_config = ClusterCompute(
             id=self.DEFAULT_CLUSTER_COMPUTE_ID,
@@ -347,6 +368,25 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
     def get_cloud(self, *, cloud_id: str) -> Optional[Cloud]:
         return self._clouds.get(cloud_id, None)
 
+    def add_cloud_collaborators(
+        self, cloud_id: str, collaborators: List[CreateCloudCollaborator]
+    ) -> None:
+        existing_collaborators = [
+            collaborator.email
+            for collaborator in self._cloud_collaborators.get(cloud_id, [])
+        ]
+
+        for collaborator in collaborators:
+            if collaborator.email in existing_collaborators:
+                raise ValueError(
+                    f"Collaborator with email '{collaborator.email}' already exists in cloud '{cloud_id}'."
+                )
+
+        if cloud_id not in self._cloud_collaborators:
+            self._cloud_collaborators[cloud_id] = collaborators
+        else:
+            self._cloud_collaborators[cloud_id].extend(collaborators)
+
     def add_compute_config(self, compute_config: DecoratedComputeTemplate) -> int:
         compute_config.version = (
             len(self._compute_config_name_to_ids[compute_config.name]) + 1
@@ -579,6 +619,28 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
                     )
         return None
 
+    def add_project_collaborators(
+        self, project_id: str, collaborators: List[CreateUserProjectCollaborator]
+    ):
+        existing_collaborators = [
+            collaborator.value.email if collaborator.value else None
+            for collaborator in self._project_collaborators.get(project_id, [])
+        ]
+
+        for collaborator in collaborators:
+            if (
+                collaborator.value
+                and collaborator.value.email in existing_collaborators
+            ):
+                raise ValueError(
+                    f"Collaborator with email '{collaborator.value.email}' already exists in project '{project_id}'."
+                )
+
+        if project_id not in self._project_collaborators:
+            self._project_collaborators[project_id] = collaborators
+        else:
+            self._project_collaborators[project_id].extend(collaborators)
+
     def get_job(
         self,
         *,
@@ -702,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
@@ -908,7 +980,7 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
             compute_config_id=model.compute_config_id,
             environment_id=model.cluster_environment_build_id,
             cloud_id=model.cloud_id or self.get_cloud_id(),
-            created_at=datetime.now(),
+            created_at=datetime.utcnow(),
             creator_id=self.DEFAULT_USER_ID,
             creator_email=self.DEFAULT_USER_EMAIL,
             organization_id=self.DEFAULT_ORGANIZATION_ID,
@@ -1082,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]:
@@ -1106,3 +1192,155 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
             self._users[admin_create_user.email] = created_user
 
         return created_users
+
+    def create_organization_invitations(
+        self, emails: List[str]
+    ) -> Tuple[List[str], List[str]]:
+        success_emails, error_messages = [], []
+        for email in emails:
+            if email in self._users:
+                error_messages.append(
+                    f"User with email {email} is already a member of your organization."
+                )
+            else:
+                orginv_id = f"orginv_{uuid.uuid4()!s}"
+                self._organization_invitations[email] = OrganizationInvitation(
+                    email=email,
+                    id=orginv_id,
+                    organization_id="org_1",
+                    created_at=datetime.utcnow(),
+                    expires_at=datetime.utcnow(),
+                )
+                success_emails.append(email)
+
+        return success_emails, error_messages
+
+    def list_organization_invitations(self) -> List[OrganizationInvitation]:
+        return list(self._organization_invitations.values())
+
+    def delete_organization_invitation(self, email: str) -> OrganizationInvitation:
+        if email not in self._organization_invitations:
+            raise ValueError(f"Invitation for email '{email}' not found.")
+
+        return self._organization_invitations.pop(email)
+
+    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,
+            id=identity_id,
+            name=name,
+            email=f"{name}@service-account.com",
+            user_id=user_id,
+            created_at=datetime.utcnow(),
+        )
+
+        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(
+        self, create_resource_quota: CreateResourceQuota
+    ) -> ResourceQuota:
+        resource_quota_id = f"rq_{uuid.uuid4()!s}"
+        resource_quota = ResourceQuota(
+            id=resource_quota_id,
+            name=create_resource_quota.name,
+            cloud_id=create_resource_quota.cloud_id,
+            project_id=create_resource_quota.project_id,
+            quota=create_resource_quota.quota,
+            is_enabled=True,
+            created_at=datetime.utcnow(),
+            creator=MiniUser(
+                id="user_1",
+                email="test@anyscale.com",
+                name="Test User",
+                username="testuser",
+            ),
+            cloud=MiniCloud(
+                id=create_resource_quota.cloud_id,
+                name="Test Cloud",
+                provider=CloudProviders.AWS,
+            ),
+        )
+
+        self._resource_quotas[resource_quota_id] = resource_quota
+
+        return self._resource_quotas[resource_quota_id]
+
+    def list_resource_quotas(
+        self,
+        name: Optional[str] = None,
+        cloud_id: Optional[str] = None,
+        creator_id: Optional[str] = None,
+        is_enabled: Optional[bool] = None,
+        max_items: int = 20,
+    ) -> List[ResourceQuota]:
+        results = []
+        for resource_quota in self._resource_quotas.values():
+            if name and resource_quota.name != name:
+                continue
+            if cloud_id and resource_quota.cloud_id != cloud_id:
+                continue
+            if creator_id and resource_quota.creator.id != creator_id:
+                continue
+            if is_enabled is not None and resource_quota.is_enabled != is_enabled:
+                continue
+            results.append(resource_quota)
+
+        return results[:max_items]
+
+    def delete_resource_quota(self, resource_quota_id: str) -> None:
+        if resource_quota_id not in self._resource_quotas:
+            raise ValueError(f"Resource Quota with id '{resource_quota_id}' not found.")
+
+        self._resource_quotas.pop(resource_quota_id)
+
+    def set_resource_quota_status(
+        self, resource_quota_id: str, is_enabled: bool
+    ) -> None:
+        resource_quota = self._resource_quotas.get(resource_quota_id)
+        if resource_quota is None:
+            raise ValueError(f"Resource Quota with id '{resource_quota_id}' not found.")
+
+        resource_quota.is_enabled = is_enabled

anyscale/_private/docgen/README.md

@@ -1,4 +1,4 @@
-Tool to autogenerate documentation for the Anyscale SDK/CLI that can be embedded in a [Docusarus](https://docusaurus.io/) site.
+Tool to autogenerate documentation for the Anyscale SDK/CLI that can be embedded in a [Docusarus](https://docusaurus.io/) site. If you're adding a new API reference in anyscale/product, follow this guide to see what changes you need to make: https://www.notion.so/anyscale-hq/How-to-document-new-anyscale-API-references-173027c809cb8080b8e3e53fc244d70b.
 
 This is used by: https://github.com/anyscale/docs/tree/master/docs/reference.
 

anyscale/_private/docgen/__main__.py

@@ -10,6 +10,10 @@ import anyscale
 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 (
+    CloudPermissionLevel,
+    CreateCloudCollaborator,
+)
 from anyscale.commands import (
     aggregated_instance_usage_commands,
     cloud_commands,
@@ -22,6 +26,7 @@ from anyscale.commands import (
     logs_commands,
     machine_commands,
     machine_pool_commands,
+    organization_invitation_commands,
     project_commands,
     resource_quota_commands,
     schedule_commands,
@@ -58,6 +63,9 @@ from anyscale.llm.model.models import (
     FineTunedModel,
     FineTuningType,
 )
+from anyscale.organization_invitation.models import OrganizationInvitation
+from anyscale.project.models import CreateProjectCollaborator, ProjectPermissionLevel
+from anyscale.resource_quota.models import CreateResourceQuota, Quota, ResourceQuota
 from anyscale.schedule.models import ScheduleConfig, ScheduleState, ScheduleStatus
 from anyscale.service.models import (
     RayGCSExternalStorageConfig,
@@ -68,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
 
@@ -92,6 +101,32 @@ ALL_MODULES = [
         sdk_commands=[anyscale.user.admin_batch_create,],
         models=[AdminCreateUser, AdminCreatedUser],
     ),
+    Module(
+        title="Project",
+        filename="project-api.md",
+        cli_prefix="anyscale project",
+        cli_commands=[project_commands.add_collaborators,],
+        sdk_prefix="anyscale.project",
+        sdk_commands=[anyscale.project.add_collaborators,],
+        models=[ProjectPermissionLevel, CreateProjectCollaborator],
+        legacy_cli_commands=[project_commands.create, project_commands.list,],
+        legacy_sdk_commands={
+            "create_project": None,
+            "delete_project": None,
+            "get_default_project": None,
+            "get_project": None,
+            "search_projects": None,
+            "update_project": None,
+        },
+        legacy_sdk_models=[
+            "CreateProject",
+            "Project",
+            "ProjectListResponse",
+            "ProjectResponse",
+            "ProjectsQuery",
+            "UpdateProject",
+        ],
+    ),
     Module(
         title="Job",
         filename="job-api.md",
@@ -322,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",
@@ -401,10 +442,11 @@ ALL_MODULES = [
             cloud_commands.list_cloud,
             cloud_commands.cloud_config_update,
             cloud_commands.cloud_set_default,
+            cloud_commands.add_collaborators,
         ],
         sdk_prefix="anyscale.cloud",
-        sdk_commands=[],
-        models=[],
+        sdk_commands=[anyscale.cloud.add_collaborators],
+        models=[CloudPermissionLevel, CreateCloudCollaborator],
         cli_command_group_prefix={cloud_commands.cloud_config_update: "config"},
         legacy_sdk_commands={
             # limited support, no replacement yet
@@ -580,8 +622,31 @@ ALL_MODULES = [
             resource_quota_commands.disable,
         ],
         sdk_prefix="anyscale.resource_quota",
-        sdk_commands=[],  # No SDK commands for resource quotas
-        models=[],
+        sdk_commands=[
+            anyscale.resource_quota.create,
+            anyscale.resource_quota.list,
+            anyscale.resource_quota.delete,
+            anyscale.resource_quota.enable,
+            anyscale.resource_quota.disable,
+        ],
+        models=[CreateResourceQuota, Quota, ResourceQuota],
+    ),
+    Module(
+        title="Organization Invitation",
+        filename="organization-invitation.md",
+        cli_prefix="anyscale organization-invitation",
+        cli_commands=[
+            organization_invitation_commands.create,
+            organization_invitation_commands.list,
+            organization_invitation_commands.delete,
+        ],
+        sdk_prefix="anyscale.organization-invitation",
+        sdk_commands=[
+            anyscale.organization_invitation.create,
+            anyscale.organization_invitation.list,
+            anyscale.organization_invitation.delete,
+        ],
+        models=[OrganizationInvitation],
     ),
     Module(
         title="Other",
@@ -600,23 +665,14 @@ ALL_MODULES = [
         legacy_cli_commands=[
             machine_commands.delete_machine,
             machine_commands.list_machines,
-            project_commands.create,
-            project_commands.list,
         ],
         legacy_sdk_commands={
             "get_organization_temporary_object_storage_credentials": None,
             "partial_update_organization": None,
-            "create_project": None,
-            "delete_project": None,
-            "get_default_project": None,
-            "get_project": None,
-            "search_projects": None,
-            "update_project": None,
             "get_runtime_environment": None,
             "create_session_command": None,
             "get_session_command": None,
             "list_session_commands": None,
-            "get_session_event_log": None,
             "upsert_sso_config": None,
             "upsert_test_sso_config": None,
         },
@@ -630,7 +686,6 @@ ALL_MODULES = [
             "BuildResponse",
             "BuildStatus",
             "CreateBuild",
-            "CreateProject",
             "CreateSSOConfig",
             "GrpcProtocolConfig",
             "HTTPValidationError",
@@ -647,10 +702,6 @@ ALL_MODULES = [
             "Organization",
             "OrganizationResponse",
             "PageQuery",
-            "Project",
-            "ProjectListResponse",
-            "ProjectResponse",
-            "ProjectsQuery",
             "Protocols",
             "PythonModules",
             "PythonVersion",
@@ -665,7 +716,6 @@ ALL_MODULES = [
             "TextQuery",
             "TracingConfig",
             "UpdateOrganization",
-            "UpdateProject",
             "UserServiceAccessTypes",
             "WorkerNodeType",
         ],

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
@@ -1058,26 +1071,6 @@ Name | Type | Description  | Notes
 
 Returns [SessioncommandListResponse](./models.md#sessioncommandlistresponse)
 
-## Session Events
-
-### get_session_event_log
-
-Retrieves a session's event log.
-
-Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- `session_id` | str| ID of the Session to retrieve event logs for. | Defaults to null
- `before` | optional datetime| Filters events occurring before this datetime. | Defaults to null
- `after` | optional datetime| Filters events occurring after this datetime. | Defaults to null
- `event_types` | [List[SessionEventTypes]](./models.md#sessioneventtypes)| Filters events to these types. | Defaults to null
- `log_level_types` | [List[LogLevelTypes]](./models.md#logleveltypes)| Filters logs to these leves. | Defaults to null
- `paging_token` | optional str|  | Defaults to null
- `count` | optional int|  | Defaults to 20
-
-Returns [SessioneventListResponse](./models.md#sessioneventlistresponse)
-
 ## Sso Configs
 
 ### upsert_sso_config

anyscale/_private/docgen/generator.py

@@ -179,10 +179,11 @@ class MarkdownGenerator:
             output = f"## {m.title} CLI\n"
 
         for t in commands or []:
+            cli_command_prefix = cli_prefix
             if m.cli_command_group_prefix and t in m.cli_command_group_prefix:
-                cli_prefix = f"{cli_prefix} {m.cli_command_group_prefix[t]}"
+                cli_command_prefix = f"{cli_prefix} {m.cli_command_group_prefix[t]}"
             output += "\n" + self._gen_markdown_for_cli_command(
-                t, cli_prefix=cli_prefix or ""
+                t, cli_prefix=cli_command_prefix or ""
             )
 
         return output