anyscale 0.24.39__tar.gz → 0.24.40__tar.gz

{anyscale-0.24.39 → anyscale-0.24.40}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: anyscale
-Version: 0.24.39
+Version: 0.24.40
 Summary: Command Line Interface for Anyscale
 Author: Anyscale Inc.
 License: AS License

{anyscale-0.24.39 → anyscale-0.24.40}/anyscale/_private/anyscale_client/anyscale_client.py

@@ -794,12 +794,14 @@ class AnyscaleClient(AnyscaleClientInterface):
                 "This should not happen, so please contact Anyscale support."
             )
 
-    def get_service(self, name: str) -> Optional[ServiceModel]:
+    def get_service(
+        self, name: str, *, cloud: Optional[str], project: Optional[str]
+    ) -> Optional[ServiceModel]:
         # TODO(edoakes): this endpoint is very slow and there's no reason we should need
         # to use this complex list endpoint just to fetch a service by name.
         paging_token = None
-        cloud_id = self.get_cloud_id()
-        project_id = self.get_project_id(parent_cloud_id=cloud_id)
+        cloud_id = self.get_cloud_id(cloud_name=cloud)
+        project_id = self.get_project_id(parent_cloud_id=cloud_id, name=project)
         service: Optional[ServiceModel] = None
         while True:
             resp = self._external_api_client.list_services(

{anyscale-0.24.39 → anyscale-0.24.40}/anyscale/_private/anyscale_client/common.py

@@ -254,8 +254,10 @@ class AnyscaleClientInterface(ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def get_service(self, name: str) -> Optional[ServiceModel]:
-        """Get a service by name.
+    def get_service(
+        self, name: str, *, cloud: Optional[str], project: Optional[str]
+    ) -> Optional[ServiceModel]:
+        """Get a service by name. Filter by cloud and project.
 
         Returns None if not found.
         """

{anyscale-0.24.39 → anyscale-0.24.40}/anyscale/_private/anyscale_client/fake_anyscale_client.py

@@ -55,7 +55,9 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
     CLOUD_BUCKET = "s3://fake-bucket/{cloud_id}"
     DEFAULT_CLOUD_ID = "fake-default-cloud-id"
     DEFAULT_CLOUD_NAME = "fake-default-cloud"
+    DEFAULT_PROJECT_NAME = "fake-default-project"
     DEFAULT_PROJECT_ID = "fake-default-project-id"
+    DEFAULT_CLUSTER_COMPUTE_NAME = "fake-default-cluster-compute"
     DEFAULT_CLUSTER_COMPUTE_ID = "fake-default-cluster-compute-id"
     DEFAULT_CLUSTER_ENV_BUILD_ID = "fake-default-cluster-env-build-id"
 
@@ -134,6 +136,7 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
         # Cloud ID -> default ClusterCompute.
         compute_config = ClusterCompute(
             id=self.DEFAULT_CLUSTER_COMPUTE_ID,
+            name=self.DEFAULT_CLUSTER_COMPUTE_NAME,
             config=ClusterComputeConfig(
                 cloud_id=self.DEFAULT_CLOUD_ID,
                 head_node_type=ComputeNodeType(
@@ -507,9 +510,18 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
     def update_service(self, model: ServiceModel):
         self._services[model.id] = model
 
-    def get_service(self, name: str) -> Optional[ServiceModel]:
+    def get_service(
+        self, name: str, *, cloud: Optional[str], project: Optional[str]
+    ) -> Optional[ServiceModel]:
+        cloud_id = self.get_cloud_id(cloud_name=cloud)
+        cloud_project_dict = self._project_to_id.get(cloud_id, None)
+        project_id = (
+            cloud_project_dict.get(project, None) if cloud_project_dict else None
+        )
         for service in self._services.values():
-            if service.name == name:
+            if service.name == name and (
+                project_id is None or service.project_id == project_id
+            ):
                 return service
 
         return None
@@ -564,7 +576,7 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
         self._job_runs[prod_job_id].append(model)
 
     def register_project_by_name(
-        self, name: str, cloud: str = DEFAULT_CLOUD_NAME
+        self, name: str, cloud: str = DEFAULT_CLOUD_NAME, project_id: str = None
     ) -> str:
         """Helper method to create project name to project id mapping."""
         cloud_id = self.get_cloud_id(cloud_name=cloud)
@@ -574,7 +586,8 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
         if name in cloud_project_dict:
             return cloud_project_dict[name]
         else:
-            project_id = f"project-id-{uuid.uuid4()!s}"
+            if project_id is None:
+                project_id = f"project-id-{uuid.uuid4()!s}"
             cloud_project_dict[name] = project_id
             return project_id
 
@@ -584,7 +597,14 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
 
     def rollout_service(self, model: ApplyServiceModel) -> ServiceModel:
         self._rolled_out_model = model
-        existing_service = self.get_service(model.name)
+        # TODO(mowen): This feels convoluted, is there a better way to pull cloud name and project name from the model?
+        project_model = self.get_project(model.project_id)
+        project = project_model.name if project_model else None
+        compute_config = self.get_compute_config(model.compute_config_id)
+        cloud_id = compute_config.config.cloud_id if compute_config else None
+        cloud_model = self.get_cloud(cloud_id=cloud_id)
+        cloud = cloud_model.name if cloud_model else None
+        existing_service = self.get_service(model.name, project=project, cloud=cloud)
         if existing_service is not None:
             service_id = existing_service.id
         else:
@@ -594,6 +614,8 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
             id=service_id,
             name=model.name,
             current_state=ServiceEventCurrentState.RUNNING,
+            cloud_id=cloud_id,
+            project_id=model.project_id,
             base_url="http://fake-service-url",
             auth_token="fake-auth-token"
             if model.config.access.use_bearer_token

{anyscale-0.24.39 → anyscale-0.24.40}/anyscale/_private/docgen/__main__.py

@@ -154,6 +154,7 @@ ALL_MODULES = [
         sdk_prefix="anyscale.cloud",
         sdk_commands=[],
         models=[],
+        cli_command_group_prefix={cloud_commands.cloud_config_update: "config"},
     ),
     Module(
         title="Logs",

{anyscale-0.24.39 → anyscale-0.24.40}/anyscale/_private/docgen/generator.py

@@ -36,6 +36,7 @@ class Module:
     sdk_prefix: str
     sdk_commands: List[Callable]
     models: List[ModelType]
+    cli_command_group_prefix: Optional[Dict[click.Command, str]] = None
 
 
 class MarkdownGenerator:
@@ -91,8 +92,12 @@ class MarkdownGenerator:
                     f"  - [{m.title} CLI]({filename_no_extension}#{title_anchor}-cli)\n"
                 )
                 for t in m.cli_commands:
+                    if m.cli_command_group_prefix and t in m.cli_command_group_prefix:
+                        cli_prefix = f"{m.cli_prefix} {m.cli_command_group_prefix[t]}"
+                    else:
+                        cli_prefix = m.cli_prefix
                     output += "\n" + self._gen_markdown_for_cli_command(
-                        t, cli_prefix=m.cli_prefix
+                        t, cli_prefix=cli_prefix
                     )
 
             if len(m.sdk_commands) > 0:
@@ -321,7 +326,7 @@ class MarkdownGenerator:
                 if param["name"] in CLI_OPTIONS_TO_SKIP:
                     continue
 
-                name = "/".join(param["opts"])
+                name = "/".join(param["opts"] + param.get("secondary_opts", []))
                 help_str = param.get("help", None)
                 assert (
                     help_str

{anyscale-0.24.39 → anyscale-0.24.40}/anyscale/commands/job_commands.py

@@ -36,16 +36,6 @@ def job_cli() -> None:
     name="submit", short_help="Submit a job.",
 )
 @click.option("-n", "--name", required=False, default=None, help="Name of the job.")
-@click.option(
-    "-f",
-    "--follow",
-    required=False,
-    hidden=True,
-    default=False,
-    type=bool,
-    is_flag=True,
-    help="DEPRECATED: use `--wait` instead.",
-)
 @click.option(
     "-w",
     "--wait",
@@ -57,6 +47,7 @@ def job_cli() -> None:
 )
 @click.option(
     "--config-file",
+    "-f",
     required=False,
     default=None,
     type=str,
@@ -150,11 +141,17 @@ def job_cli() -> None:
     type=str,
     help="The Ray version (X.Y.Z) to the image specified by --image-uri. This is only used when --image-uri is provided. If not provided, the latest Ray version will be used.",
 )
+@click.option(
+    "--max-retries",
+    required=False,
+    default=None,
+    type=int,
+    help="Maximum number of retries to attempt before failing the entire job.",
+)
 @click.argument("entrypoint", required=False, nargs=-1, type=click.UNPROCESSED)
 def submit(  # noqa: PLR0912 PLR0913 C901
     entrypoint: Tuple[str],
     name: Optional[str],
-    follow: Optional[bool],
     wait: Optional[bool],
     config_file: Optional[str],
     compute_config: Optional[str],
@@ -169,6 +166,7 @@ def submit(  # noqa: PLR0912 PLR0913 C901
     py_module: Tuple[str],
     cloud: Optional[str],
     project: Optional[str],
+    max_retries: Optional[int],
 ):
     """Submit a job.
 
@@ -241,11 +239,6 @@ and override the entrypoint with `python main.py`.
         if config_file is not None and not pathlib.Path(config_file).is_file():
             raise click.ClickException(f"Job config file '{config_file}' not found.")
 
-        if follow:
-            raise click.ClickException(
-                "`--follow` is deprecated, use `--wait` instead."
-            )
-
         args = {}
         if len(entrypoint) > 0:
             args["entrypoint"] = list2cmdline(entrypoint)
@@ -319,6 +312,9 @@ and override the entrypoint with `python main.py`.
         if project is not None:
             config = config.options(project=project)
 
+        if max_retries is not None:
+            config = config.options(max_retries=max_retries)
+
         log.info(f"Submitting job with config {config}.")
         job_id = anyscale.job.submit(config)
 

{anyscale-0.24.39 → anyscale-0.24.40}/anyscale/commands/service_commands.py

@@ -160,6 +160,20 @@ def _read_name_from_config_file(path: str):
     type=str,
     help="Python modules to be available for import in the Ray workers. Each entry must be a path to a local directory.",
 )
+@click.option(
+    "--cloud",
+    required=False,
+    default=None,
+    type=str,
+    help="The Anyscale Cloud to run this workload on. If not provided, the organization default will be used (or, if running in a workspace, the cloud of the workspace).",
+)
+@click.option(
+    "--project",
+    required=False,
+    default=None,
+    type=str,
+    help="Named project to use for the service. If not provided, the default project for the cloud will be used (or, if running in a workspace, the project of the workspace).",
+)
 def deploy(  # noqa: PLR0912, PLR0913 C901
     config_file: Optional[str],
     import_path: Optional[str],
@@ -178,6 +192,8 @@ def deploy(  # noqa: PLR0912, PLR0913 C901
     max_surge_percent: Optional[int],
     env: Optional[Tuple[str]],
     py_module: Tuple[str],
+    cloud: Optional[str],
+    project: Optional[str],
 ):
     """Deploy or update a service.
 
@@ -282,6 +298,11 @@ def deploy(  # noqa: PLR0912, PLR0913 C901
                 )
         config = config.options(py_modules=[*py_module])
 
+    if cloud is not None:
+        config = config.options(cloud=cloud)
+    if project is not None:
+        config = config.options(project=project)
+
     anyscale.service.deploy(
         config,
         in_place=in_place,
@@ -304,6 +325,20 @@ def deploy(  # noqa: PLR0912, PLR0913 C901
     type=str,
     help="Path to a YAML config file to read the name from.",
 )
+@click.option(
+    "--cloud",
+    required=False,
+    default=None,
+    type=str,
+    help="The Anyscale Cloud to run this workload on. If not provided, the organization default will be used (or, if running in a workspace, the cloud of the workspace).",
+)
+@click.option(
+    "--project",
+    required=False,
+    default=None,
+    type=str,
+    help="Named project to use for the service. If not provided, the default project for the cloud will be used (or, if running in a workspace, the project of the workspace).",
+)
 @click.option(
     "-j",
     "--json",
@@ -318,7 +353,14 @@ def deploy(  # noqa: PLR0912, PLR0913 C901
     default=False,
     help="Include verbose details in the status.",
 )
-def status(name: Optional[str], config_file: Optional[str], json: bool, verbose: bool):
+def status(
+    name: Optional[str],
+    config_file: Optional[str],
+    cloud: Optional[str],
+    project: Optional[str],
+    json: bool,
+    verbose: bool,
+):
     if name is not None and config_file is not None:
         raise click.ClickException(
             "Only one of '--name' and '--config-file' can be provided."
@@ -332,7 +374,9 @@ def status(name: Optional[str], config_file: Optional[str], json: bool, verbose:
             "Service name must be provided using '--name' or in a config file using '-f'."
         )
 
-    status: ServiceStatus = anyscale.service.status(name=name)
+    status: ServiceStatus = anyscale.service.status(
+        name=name, cloud=cloud, project=project
+    )
     status_dict = status.to_dict()
     if not verbose:
         # TODO(edoakes): consider adding this as an API on the model itself if it
@@ -362,6 +406,20 @@ def status(name: Optional[str], config_file: Optional[str], json: bool, verbose:
     type=str,
     help="Path to a YAML config file to read the name from.",
 )
+@click.option(
+    "--cloud",
+    required=False,
+    default=None,
+    type=str,
+    help="The Anyscale Cloud to run this workload on. If not provided, the organization default will be used (or, if running in a workspace, the cloud of the workspace).",
+)
+@click.option(
+    "--project",
+    required=False,
+    default=None,
+    type=str,
+    help="Named project to use for the service. If not provided, the default project for the cloud will be used (or, if running in a workspace, the project of the workspace).",
+)
 @click.option(
     "-s",
     "--state",
@@ -375,7 +433,14 @@ def status(name: Optional[str], config_file: Optional[str], json: bool, verbose:
     type=float,
     help="Timeout to wait for the service to reach the target state. Defaults to 600s (10min).",
 )
-def wait(name: Optional[str], config_file: Optional[str], state: str, timeout_s: int):
+def wait(
+    name: Optional[str],
+    config_file: Optional[str],
+    cloud: Optional[str],
+    project: Optional[str],
+    state: str,
+    timeout_s: int,
+):
     try:
         state = ServiceState.validate(state)
     except ValueError as e:
@@ -394,7 +459,9 @@ def wait(name: Optional[str], config_file: Optional[str], state: str, timeout_s:
             "Service name must be provided using '--name' or in a config file using '-f'."
         )
 
-    anyscale.service.wait(name=name, state=state, timeout_s=timeout_s)
+    anyscale.service.wait(
+        name=name, cloud=cloud, project=project, state=state, timeout_s=timeout_s
+    )
 
 
 @service_cli.command(
@@ -477,6 +544,7 @@ def rollout(  # noqa: PLR0913
     )
 
 
+# TODO(mowen): Add cloud support for this when we refactor to new SDK method
 @service_cli.command(name="list", help="Display information about services.")
 @click.option(
     "--name", "-n", required=False, default=None, help="Filter by service name."
@@ -522,6 +590,7 @@ def list(  # noqa: A001
     )
 
 
+# TODO(mowen): Add cloud support for this when we refactor to new SDK method
 @service_cli.command(name="rollback", help="Roll back a service.")
 @click.option(
     "--service-id", "--id", default=None, help="ID of service.",
@@ -559,6 +628,7 @@ def rollback(
     service_controller.rollback(service_id, max_surge_percent)
 
 
+# TODO(mowen): Add cloud support for this when we refactor to new SDK method
 @service_cli.command(name="terminate", help="Terminate a service.")
 @click.option(
     "--service-id", "--id", required=False, help="ID of service.",

{anyscale-0.24.39 → anyscale-0.24.40}/anyscale/job/models.py

@@ -72,7 +72,7 @@ image_uri: anyscale/image/my-image:1
 
 
 class JobRunState(ModelEnum):
-    """Current state of a job run."""
+    """Current state of an individual job run."""
 
     STARTING = "STARTING"
     RUNNING = "RUNNING"
@@ -91,7 +91,7 @@ class JobRunState(ModelEnum):
 
 @dataclass(frozen=True)
 class JobRunStatus(ModelBase):
-    """Current status of a job."""
+    """Current status of an individual job run."""
 
     __doc_py_example__ = """\
 import anyscale

{anyscale-0.24.39 → anyscale-0.24.40}/anyscale/service/__init__.py

@@ -65,7 +65,12 @@ class ServiceSDK:
         doc_py_example=_ROLLBACK_EXAMPLE, arg_docstrings=_ROLLBACK_ARG_DOCSTRINGS,
     )
     def rollback(  # noqa: F811
-        self, name: Optional[str] = None, *, max_surge_percent: Optional[int] = None
+        self,
+        name: Optional[str] = None,
+        *,
+        cloud: Optional[str] = None,
+        project: Optional[str] = None,
+        max_surge_percent: Optional[int] = None,
     ) -> str:
         """Rollback to the primary version of the service.
 
@@ -77,27 +82,35 @@ class ServiceSDK:
         Returns the id of the rolled back service.
         """
         return self._private_sdk.rollback(
-            name=name, max_surge_percent=max_surge_percent
+            name=name, max_surge_percent=max_surge_percent, cloud=cloud, project=project
         )
 
     @sdk_docs(
         doc_py_example=_TERMINATE_EXAMPLE, arg_docstrings=_TERMINATE_ARG_DOCSTRINGS,
     )
-    def terminate(self, name: Optional[str] = None) -> str:  # noqa: F811
+    def terminate(  # noqa: F811
+        self,
+        name: Optional[str] = None,
+        *,
+        cloud: Optional[str] = None,
+        project: Optional[str] = None,
+    ) -> str:
         """Terminate a service.
 
         This command is asynchronous, so it always returns immediately.
 
         Returns the id of the terminated service.
         """
-        return self._private_sdk.terminate(name=name)
+        return self._private_sdk.terminate(name=name, cloud=cloud, project=project)
 
     @sdk_docs(
         doc_py_example=_STATUS_EXAMPLE, arg_docstrings=_STATUS_ARG_DOCSTRINGS,
     )
-    def status(self, name: str,) -> ServiceStatus:  # noqa: F811
+    def status(  # noqa: F811
+        self, name: str, *, cloud: Optional[str] = None, project: Optional[str] = None
+    ) -> ServiceStatus:
         """Get the status of a service."""
-        return self._private_sdk.status(name=name,)
+        return self._private_sdk.status(name=name, cloud=cloud, project=project)
 
     @sdk_docs(
         doc_py_example=_WAIT_EXAMPLE, arg_docstrings=_WAIT_ARG_DOCSTRINGS,
@@ -106,6 +119,8 @@ class ServiceSDK:
         self,
         name: str,
         *,
+        cloud: Optional[str] = None,
+        project: Optional[str] = None,
         state: Union[str, ServiceState] = ServiceState.RUNNING,
         timeout_s: float = 600,
         _interval_s: float = 5,
@@ -113,6 +128,8 @@ class ServiceSDK:
         """Wait for a service to reach a target state."""
         return self._private_sdk.wait(
             name=name,
+            cloud=cloud,
+            project=project,
             state=ServiceState(state),
             timeout_s=timeout_s,
             interval_s=_interval_s,