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

anyscale/commands/command_examples.py

@@ -217,6 +217,10 @@ $ anyscale machine-pool update --name can-testing --spec-file spec.yaml
 Updated machine pool 'can-testing'.
 """
 
+MACHINE_POOL_DESCRIBE_EXAMPLE = """\
+$ anyscale machine-pool describe --name can-testing --mode machines
+"""
+
 MACHINE_POOL_DELETE_EXAMPLE = """\
 $ anyscale machine-pool delete --name can-testing
 Deleted machine pool 'can-testing'.
@@ -498,4 +502,65 @@ USER_BATCH_CREATE_EXAMPLE = """\
 $ anyscale user batch-create --users-file users.yaml
 (anyscale +0.5s) Creating users...
 (anyscale +0.8s) 2 users created.
+
+$ cat users_file.yaml
+create_users:
+  - name: name1
+    email: test1@anyscale.com
+    password: ''
+    is_sso_user: false
+    lastname: lastname1
+    title: title1
+  - name: name2
+    email: test2@anyscale.com
+    password: ''
+    is_sso_user: false
+    lastname: lastname2
+    title: title2
+"""
+
+ORGANIZATION_INVITATION_CREATE_EXAMPLE = """\
+$ anyscale organization-invitation create --emails test1@anyscale.com,test2@anyscale.com
+(anyscale +0.5s) Creating organization invitations...
+(anyscale +1.7s) Organization invitations sent to: test1@anyscale.com, test2@anyscale.com
+"""
+
+ORGANIZATION_INVITATION_LIST_EXAMPLE = """\
+$ anyscale organization-invitation list
+ID             Email              Created At           Expires At
+-------------  -----------------  -------------------  -------------------
+orginv_abcedf  test@anyscale.com  11/25/2024 10:24 PM  12/02/2024 10:24 PM
+"""
+
+ORGANIZATION_INVITATION_DELETE_EXAMPLE = """\
+$ anyscale organization-invitation delete --email test@anyscale.com
+(anyscale +0.6s) Organization invitation for test@anyscale.com deleted.
+"""
+
+PROJECT_ADD_COLLABORATORS_EXAMPLE = """\
+$ anyscale project add-collaborators --cloud cloud_name --project project_name --users-file collaborators.yaml
+(anyscale +1.3s) Successfully added 3 collaborators to project project_name.
+$ cat collaborators.yaml
+collaborators:
+  - email: "test1@anyscale.com"
+    permission_level: "write"
+  - email: "test2@anyscale.com"
+    permission_level: "readonly"
+  - email: "test3@anyscale.com"
+    permission_level: "owner"
+"""
+
+CLOUD_ADD_COLLABORATORS_EXAMPLE = """\
+$ anyscale cloud add-collaborators --cloud cloud_name --users-file collaborators.yaml
+(anyscale +1.3s) Successfully added 2 collaborators to cloud cloud_name.
+$ cat collaborators.yaml
+collaborators:
+  - email: "test1@anyscale.com"
+    permission_level: "write"
+  - email: "test2@anyscale.com"
+    permission_level: "readonly"
+"""
+
+SERVICE_ARCHIVE_EXAMPLE = """\
+$ anyscale service archive --name my_service
 """

anyscale/commands/job_commands.py

@@ -2,7 +2,7 @@ from io import StringIO
 from json import dumps as json_dumps
 import pathlib
 from subprocess import list2cmdline
-from typing import Optional, Tuple
+from typing import List, Optional, Tuple
 
 import click
 import yaml
@@ -10,6 +10,7 @@ import yaml
 import anyscale
 from anyscale._private.models.image_uri import ImageURI
 from anyscale.cli_logger import BlockLogger
+from anyscale.client.openapi_client.models.ha_job_states import HaJobStates
 from anyscale.commands import command_examples
 from anyscale.commands.util import (
     AnyscaleCommand,
@@ -18,7 +19,7 @@ from anyscale.commands.util import (
 )
 from anyscale.controllers.job_controller import JobController
 from anyscale.job.models import JobConfig, JobLogMode, JobState, JobStatus
-from anyscale.util import validate_non_negative_arg
+from anyscale.util import validate_list_jobs_state_filter, validate_non_negative_arg
 
 
 log = BlockLogger()  # CLI Logger
@@ -118,7 +119,7 @@ def job_cli() -> None:
     required=False,
     default=None,
     type=str,
-    help="Path to a requirements.txt file containing dependencies for the job. These will be installed on top of the image. When running in a workspace, this defaults to the workspace dependencies.",
+    help="Path to a requirements.txt file containing dependencies for the job. Anyscale installs these dependencies on top of the image. If you run a job from a workspace, the default is to use the workspace dependencies, but specifying this option overrides them.",
 )
 @click.option(
     "--py-module",
@@ -386,6 +387,15 @@ and override the entrypoint with `python main.py`.
     help="Max items to show in list.",
     callback=validate_non_negative_arg,
 )
+@click.option(
+    "--state",
+    "-s",
+    "states",
+    required=False,
+    multiple=True,
+    help=f"Filter jobs by state. Accepts one or more states. Allowed states: {', '.join(HaJobStates.allowable_values)}",
+    callback=validate_list_jobs_state_filter,
+)
 def list(  # noqa: A001
     name: Optional[str],
     id: Optional[str],  # noqa: A002
@@ -393,6 +403,7 @@ def list(  # noqa: A001
     include_all_users: bool,
     include_archived: bool,
     max_items: int,
+    states: List[str],
 ) -> None:
     job_controller = JobController()
     job_controller.list(
@@ -402,6 +413,7 @@ def list(  # noqa: A001
         include_all_users=include_all_users,
         include_archived=include_archived,
         max_items=max_items,
+        states=states,
     )
 
 

anyscale/commands/machine_pool_commands.py

@@ -2,10 +2,16 @@
 This file holds all of the CLI commands for the "anyscale machine-pool" path.
 """
 
+import json
+
 import click
 import tabulate
 import yaml
 
+from anyscale.client.openapi_client.models import (
+    DescribeMachinePoolResponse,
+    SchedulerInfo,
+)
 from anyscale.commands import command_examples
 from anyscale.commands.util import AnyscaleCommand
 from anyscale.controllers.machine_pool_controller import MachinePoolController
@@ -71,6 +77,110 @@ def update_machine_pool(name: str, spec_file: str) -> None:
     print(f"Updated machine pool '{name}'.")
 
 
+@machine_pool_cli.command(
+    name="describe",
+    help="Describe a machine pool in Anyscale.",
+    cls=AnyscaleCommand,
+    example=command_examples.MACHINE_POOL_DESCRIBE_EXAMPLE,
+    is_beta=True,
+)
+@click.option("--name", type=str, required=True, help="Provide a machine pool name.")
+@click.option(
+    "--format",
+    "format_",
+    type=str,
+    default="table",
+    required=False,
+    help="Output format (table, json).",
+)
+def describe(name: str, format_: str) -> None:
+    machine_pool_controller = MachinePoolController()
+    response: DescribeMachinePoolResponse = machine_pool_controller.describe_machine_pool(
+        machine_pool_name=name
+    )
+    scheduler_info: SchedulerInfo = response.scheduler_info  # type: ignore
+    if format_ == "json":
+        print(json.dumps(scheduler_info.to_dict(), default=str))
+    elif format_ == "table":
+        machines_table = []
+        columns = [
+            "MACHINE ID",
+            "TYPE",
+            "PARTITION",
+            "STATE",
+            "WORKLOAD DETAILS",
+            "WORKLOAD SCORE",
+            "WORKLOAD START TIME",
+            "CLOUD INSTANCE ID",
+        ]
+        for row in scheduler_info.machines:
+            machines_table.append(
+                [
+                    row.machine_id,
+                    row.machine_type,
+                    row.partition,
+                    row.allocation_state,
+                    f"{row.workload_info.workload_type}/{row.workload_info.workload_name}/{row.workload_info.workload_cloud}"
+                    if row.workload_info.workload_name
+                    else "",
+                    row.workload_score,
+                    str(
+                        row.workload_info.workload_start_time.astimezone().strftime(
+                            "%m/%d/%Y %I:%M:%S %p %Z"
+                        )
+                    )
+                    if row.workload_info.workload_name
+                    else "",
+                    row.cloud_instance_id,
+                ]
+            )
+
+        # Sort by (type, partition, state, workload start time)
+        machines_table.sort(key=lambda x: (x[1], x[2], x[3], x[6]))
+
+        print("Machines:")
+        print(
+            tabulate.tabulate(
+                machines_table, tablefmt="outline", headers=columns, stralign="left"
+            )
+        )
+
+        requests_table = []
+        columns = [
+            "SIZE",
+            "MACHINE TYPE",
+            "WORKLOAD DETAILS",
+            "WORKLOAD START TIME",
+            "WORKLOAD CLOUD",
+            "PARTITION SCORES",
+        ]
+        for row in scheduler_info.requests:
+            requests_table.append(
+                [
+                    row.size,
+                    row.machine_type,
+                    f"{row.workload_info.workload_type}/{row.workload_info.workload_name}",
+                    str(
+                        row.workload_info.workload_start_time.astimezone().strftime(
+                            "%m/%d/%Y %I:%M:%S %p %Z"
+                        )
+                    )
+                    if row.workload_info.workload_name
+                    else "",
+                    row.workload_info.workload_cloud,
+                    row.partition_scores,
+                ]
+            )
+
+        # Sort by (machine type, workload start time, size)
+        print("Requests:")
+        print(
+            tabulate.tabulate(
+                requests_table, tablefmt="outline", headers=columns, stralign="left"
+            )
+        )
+
+
 @machine_pool_cli.command(
     name="delete",
     help="Delete a machine pool in Anyscale.",
@@ -122,7 +232,9 @@ def list_machine_pools(format_: str) -> None:
                 ]
             )
         print(
-            tabulate.tabulate(table, tablefmt="plain", headers=columns, stralign="left")
+            tabulate.tabulate(
+                table, tablefmt="simple_grid", headers=columns, stralign="left"
+            )
         )
     elif format_ == "yaml":
         rows = []

anyscale/commands/organization_invitation_commands.py

@@ -0,0 +1,98 @@
+import click
+from dateutil import tz
+from rich import print as rprint
+import tabulate
+
+import anyscale
+from anyscale.cli_logger import BlockLogger
+from anyscale.commands import command_examples
+from anyscale.commands.util import AnyscaleCommand
+
+
+log = BlockLogger()  # CLI Logger
+
+
+@click.group("organization-invitation", help="Manage organization invitations.")
+def organization_invitation_cli() -> None:
+    pass
+
+
+@organization_invitation_cli.command(
+    name="create",
+    cls=AnyscaleCommand,
+    example=command_examples.ORGANIZATION_INVITATION_CREATE_EXAMPLE,
+)
+@click.option(
+    "--emails",
+    required=True,
+    type=str,
+    help="The emails to send the organization invitations to. Delimited by commas.",
+)
+def create(emails: str,) -> None:
+    """
+    Creates organization invitations for the provided emails.
+    """
+    log.info("Creating organization invitations...")
+
+    success_emails, error_messages = anyscale.organization_invitation.create(
+        emails.split(",")
+    )
+
+    if success_emails:
+        log.info(f"Organization invitations sent to: {', '.join(success_emails)}")
+
+    if error_messages:
+        for error_message in error_messages:
+            log.error(
+                f"Failed to send organization invitations with the following errors: {error_message}"
+            )
+
+
+@organization_invitation_cli.command(
+    name="list",
+    cls=AnyscaleCommand,
+    example=command_examples.ORGANIZATION_INVITATION_LIST_EXAMPLE,
+)
+def list() -> None:  # noqa: A001
+    """
+    Lists organization invitations.
+    """
+    organization_invitations = anyscale.organization_invitation.list()
+
+    table = tabulate.tabulate(
+        [
+            (
+                i.id,
+                i.email,
+                i.created_at.astimezone(tz=tz.tzlocal()).strftime("%m/%d/%Y %I:%M %p"),
+                i.expires_at.astimezone(tz=tz.tzlocal()).strftime("%m/%d/%Y %I:%M %p"),
+            )
+            for i in organization_invitations
+        ],
+        headers=["ID", "Email", "Created At", "Expires At"],
+    )
+    rprint(table)
+
+
+@organization_invitation_cli.command(
+    name="delete",
+    cls=AnyscaleCommand,
+    example=command_examples.ORGANIZATION_INVITATION_DELETE_EXAMPLE,
+)
+@click.option(
+    "--email",
+    required=True,
+    type=str,
+    help="The email of the organization invitation to delete.",
+)
+def delete(email: str,) -> None:
+    """
+    Deletes an organization invitation.
+    """
+    try:
+        organization_invitation_email = anyscale.organization_invitation.delete(email)
+    except ValueError as e:
+        log.error(f"Failed to delete organization invitation: {e}")
+        return
+
+    log.info(f"Organization invitation for {organization_invitation_email} deleted.")

anyscale/commands/project_commands.py

@@ -2,10 +2,16 @@ from typing import Optional
 
 import click
 
+import anyscale
 from anyscale.cli_logger import BlockLogger
-from anyscale.commands.util import LegacyAnyscaleCommand, NotRequiredIf
+from anyscale.commands import command_examples
+from anyscale.commands.util import AnyscaleCommand, LegacyAnyscaleCommand, NotRequiredIf
 from anyscale.controllers.project_controller import ProjectController
-from anyscale.project import validate_project_name
+from anyscale.project.models import (
+    CreateProjectCollaborator,
+    CreateProjectCollaborators,
+)
+from anyscale.project_utils import validate_project_name
 from anyscale.util import validate_non_negative_arg
 
 
@@ -201,3 +207,47 @@ def init(project_id: Optional[str], name: Optional[str],) -> None:
 def create(name: str, parent_cloud_id: str) -> None:
     project_controller = ProjectController()
     project_controller.create(name, parent_cloud_id)
+
+
+@project_cli.command(
+    name="add-collaborators",
+    help="Add collaborators to the project.",
+    cls=AnyscaleCommand,
+    example=command_examples.PROJECT_ADD_COLLABORATORS_EXAMPLE,
+)
+@click.option(
+    "--cloud",
+    "-c",
+    help="Name of the cloud that the project belongs to.",
+    required=True,
+)
+@click.option(
+    "--project",
+    "-p",
+    help="Name of the project 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 project.",
+    required=True,
+)
+def add_collaborators(cloud: str, project: str, users_file: str,) -> None:
+    collaborators = CreateProjectCollaborators.from_yaml(users_file)
+
+    try:
+        anyscale.project.add_collaborators(
+            cloud=cloud,
+            project=project,
+            collaborators=[
+                CreateProjectCollaborator(**collaborator)
+                for collaborator in collaborators.collaborators
+            ],
+        )
+    except ValueError as e:
+        log.error(f"Error adding collaborators to project: {e}")
+        return
+
+    log.info(
+        f"Successfully added {len(collaborators.collaborators)} collaborators to project {project}."
+    )

anyscale/commands/resource_quota_commands.py

@@ -1,11 +1,14 @@
 from typing import List, Optional, Tuple
 
 import click
+from rich import print as rprint
+import tabulate
 
+import anyscale
 from anyscale.cli_logger import BlockLogger
 from anyscale.commands import command_examples
 from anyscale.commands.util import AnyscaleCommand
-from anyscale.controllers.resource_quota_controller import ResourceQuotaController
+from anyscale.resource_quota.models import CreateResourceQuota, ResourceQuota
 from anyscale.util import validate_non_negative_arg
 
 
@@ -17,6 +20,43 @@ def resource_quota_cli() -> None:
     pass
 
 
+def _format_resource_quotas(resource_quotas: List[ResourceQuota]) -> str:
+    table_rows = []
+    for resource_quota in resource_quotas:
+        table_rows.append(
+            [
+                resource_quota.id,
+                resource_quota.name,
+                resource_quota.cloud_id,
+                resource_quota.project_id,
+                resource_quota.user_id,
+                resource_quota.is_enabled,
+                resource_quota.created_at.strftime("%m/%d/%Y"),
+                resource_quota.deleted_at.strftime("%m/%d/%Y")
+                if resource_quota.deleted_at
+                else None,
+                resource_quota.quota,
+            ]
+        )
+    table = tabulate.tabulate(
+        table_rows,
+        headers=[
+            "ID",
+            "NAME",
+            "CLOUD ID",
+            "PROJECT ID",
+            "USER ID",
+            "IS ENABLED",
+            "CREATED AT",
+            "DELETED AT",
+            "QUOTA",
+        ],
+        tablefmt="plain",
+    )
+
+    return f"Resource quotas:\n{table}"
+
+
 @resource_quota_cli.command(
     name="create",
     help="Create a resource quota.",
@@ -84,8 +124,7 @@ def create(  # noqa: PLR0913
 
     `$ anyscale resource-quota create -n my-resource-quota --cloud my-cloud --project my-project --user-email test@myorg.com --num-cpus 10 --num-instances 10 --num-gpus 10 --num-accelerators L4 5 --num-accelerators T4 10`
     """
-    resource_quota_controller = ResourceQuotaController()
-    resource_quota_controller.create(
+    create_resource_quota = CreateResourceQuota(
         name=name,
         cloud=cloud,
         project=project,
@@ -96,6 +135,35 @@ def create(  # noqa: PLR0913
         num_accelerators=dict(num_accelerators),
     )
 
+    try:
+        with log.spinner("Creating resource quota..."):
+            resource_quota = anyscale.resource_quota.create(create_resource_quota)
+
+        create_resource_quota_message = [f"Name: {name}\nCloud name: {cloud}"]
+        if project:
+            create_resource_quota_message.append(f"Project name: {project}")
+        if user_email:
+            create_resource_quota_message.append(f"User email: {user_email}")
+        if num_cpus:
+            create_resource_quota_message.append(f"Number of CPUs: {num_cpus}")
+        if num_instances:
+            create_resource_quota_message.append(
+                f"Number of instances: {num_instances}"
+            )
+        if num_gpus:
+            create_resource_quota_message.append(f"Number of GPUs: {num_gpus}")
+        if num_accelerators:
+            create_resource_quota_message.append(
+                f"Number of accelerators: {dict(num_accelerators)}"
+            )
+
+        log.info("\n".join(create_resource_quota_message))
+        log.info(f"Resource quota created successfully ID: {resource_quota.id}")
+
+    except ValueError as e:
+        log.error(f"Error creating resource quota: {e}")
+        return
+
 
 @resource_quota_cli.command(
     name="list",
@@ -141,8 +209,7 @@ def list_resource_quotas(
 
     `$ anyscale resource-quota list -n my-resource-quota --cloud my-cloud`
     """
-    resource_quota_controller = ResourceQuotaController()
-    resource_quota_controller.list_resource_quotas(
+    resource_quotas = anyscale.resource_quota.list(
         name=name,
         cloud=cloud,
         creator_id=creator_id,
@@ -150,6 +217,8 @@ def list_resource_quotas(
         max_items=max_items,
     )
 
+    rprint(_format_resource_quotas(resource_quotas))
+
 
 @resource_quota_cli.command(
     name="delete",
@@ -168,8 +237,14 @@ def delete(id: str) -> None:  # noqa: A002
 
     `$ anyscale resource-quota delete --id rsq_123`
     """
-    resource_quota_controller = ResourceQuotaController()
-    resource_quota_controller.delete(id)
+    try:
+        with log.spinner("Deleting resource quota..."):
+            anyscale.resource_quota.delete(resource_quota_id=id)
+    except ValueError as e:
+        log.error(f"Error deleting resource quota: {e}")
+        return
+
+    log.info(f"Resource quota with ID {id} deleted successfully.")
 
 
 @resource_quota_cli.command(
@@ -189,8 +264,14 @@ def enable(id: str) -> None:  # noqa: A002
 
     `$ anyscale resource-quota enable --id rsq_123`
     """
-    resource_quota_controller = ResourceQuotaController()
-    resource_quota_controller.set_status(id, is_enabled=True)
+    try:
+        with log.spinner("Setting resource quota status..."):
+            anyscale.resource_quota.enable(resource_quota_id=id)
+    except ValueError as e:
+        log.error(f"Error enabling resource quota: {e}")
+        return
+
+    log.info(f"Enabled resource quota with ID {id} successfully.")
 
 
 @resource_quota_cli.command(
@@ -210,5 +291,11 @@ def disable(id: str) -> None:  # noqa: A002
 
     `$ anyscale resource-quota disable --id rsq_123`
     """
-    resource_quota_controller = ResourceQuotaController()
-    resource_quota_controller.set_status(id, is_enabled=False)
+    try:
+        with log.spinner("Setting resource quota status..."):
+            anyscale.resource_quota.disable(resource_quota_id=id)
+    except ValueError as e:
+        log.error(f"Error disabling resource quota: {e}")
+        return
+
+    log.info(f"Disabled resource quota with ID {id} successfully.")