anyscale 0.24.27__tar.gz → 0.24.28__tar.gz

{anyscale-0.24.27 → anyscale-0.24.28}/PKG-INFO

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

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/_private/anyscale_client/anyscale_client.py

@@ -463,6 +463,11 @@ class AnyscaleClient(AnyscaleClientInterface):
 
         return self.get_default_compute_config(cloud_id=self.get_cloud_id()).id
 
+    def archive_compute_config(self, *, compute_config_id):
+        self._internal_api_client.archive_compute_template_api_v2_compute_templates_compute_template_id_archive_post(
+            compute_config_id
+        )
+
     def get_default_compute_config(self, *, cloud_id: str) -> ClusterCompute:
         return self._external_api_client.get_default_cluster_compute(
             cloud_id=cloud_id,

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/_private/anyscale_client/common.py

@@ -144,6 +144,11 @@ class AnyscaleClientInterface(ABC):
         """
         raise NotImplementedError
 
+    @abstractmethod
+    def archive_compute_config(self, *, compute_config_id: str):
+        """Archive the compute config for the provided ID."""
+        raise NotImplementedError
+
     @abstractmethod
     def get_default_compute_config(self, *, cloud_id: str) -> ClusterCompute:
         """Get the default compute config for the provided cloud ID."""

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/_private/anyscale_client/fake_anyscale_client.py

@@ -68,6 +68,7 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
         )
         self._compute_config_id_to_cloud_id: Dict[str, str] = {}
         self._compute_configs: Dict[str, ClusterCompute] = {}
+        self._archived_compute_configs: Dict[str, ClusterCompute] = {}
         self._workspace_cluster: Optional[Cluster] = None
         self._workspace_dependency_tracking_enabled: bool = False
         self._services: Dict[str, ServiceModel] = {}
@@ -260,6 +261,14 @@ class FakeAnyscaleClient(AnyscaleClientInterface):
 
         return self.get_default_compute_config(cloud_id=self.get_cloud_id()).id
 
+    def archive_compute_config(self, *, compute_config_id: str):
+        self._archived_compute_configs[compute_config_id] = self._compute_configs.pop(
+            compute_config_id
+        )
+
+    def is_archived_compute_config(self, compute_config_id: str) -> bool:
+        return compute_config_id in self._archived_compute_configs
+
     def set_default_compute_config(
         self, compute_config: ClusterCompute, *, cloud_id: str
     ):

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/_private/docgen/__main__.py

@@ -54,6 +54,7 @@ ALL_MODULES = [
         cli_commands=[
             service_commands.deploy,
             service_commands.status,
+            service_commands.wait,
             service_commands.rollback,
             service_commands.terminate,
         ],
@@ -61,6 +62,7 @@ ALL_MODULES = [
         sdk_commands=[
             anyscale.service.deploy,
             anyscale.service.status,
+            anyscale.service.wait,
             anyscale.service.rollback,
             anyscale.service.terminate,
         ],
@@ -79,7 +81,11 @@ ALL_MODULES = [
         cli_prefix="anyscale compute-config",
         cli_commands=[],
         sdk_prefix="anyscale.compute_config",
-        sdk_commands=[anyscale.compute_config.create, anyscale.compute_config.get],
+        sdk_commands=[
+            anyscale.compute_config.create,
+            anyscale.compute_config.get,
+            anyscale.compute_config.archive,
+        ],
         models=[ComputeConfig, HeadNodeConfig, WorkerNodeGroupConfig, MarketType],
     ),
 ]

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/_private/docgen/generator.py

@@ -356,7 +356,7 @@ class MarkdownGenerator:
                     continue
 
                 assert param.annotation is not inspect.Parameter.empty
-                type_str = self._model_type_to_string(param.annotation)
+                type_str = "(" + self._model_type_to_string(param.annotation) + ")"
                 if param.default != inspect.Parameter.empty:
                     type_str += f" = {param.default!s}"
 
@@ -366,7 +366,7 @@ class MarkdownGenerator:
                         f"SDK command '{sdk_prefix}.{c.__name__}' is missing a docstring for argument '{name}'"
                     )
 
-                md += f"- **`{name}` ({type_str})**: {arg_docs}"
+                md += f"- **`{name}` {type_str}**: {arg_docs}"
                 md += "\n"
             md += "\n"
 

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/_private/sdk/base_sdk.py

@@ -4,6 +4,7 @@ from anyscale._private.anyscale_client import (
     AnyscaleClient,
     AnyscaleClientInterface,
 )
+from anyscale._private.sdk.timer import RealTimer, Timer
 from anyscale.cli_logger import BlockLogger
 
 
@@ -15,9 +16,11 @@ class BaseSDK:
         *,
         logger: Optional[BlockLogger] = None,
         client: Optional[AnyscaleClientInterface] = None,
+        timer: Optional[Timer] = None,
     ):
         self._logger = logger or BlockLogger()
         self._client = client or AnyscaleClient()
+        self._timer = timer or RealTimer()
 
     @property
     def logger(self) -> BlockLogger:
@@ -26,3 +29,7 @@ class BaseSDK:
     @property
     def client(self) -> AnyscaleClientInterface:
         return self._client
+
+    @property
+    def timer(self) -> Timer:
+        return self._timer

anyscale-0.24.28/anyscale/_private/sdk/timer.py

@@ -0,0 +1,46 @@
+from abc import ABC, abstractmethod
+import time
+from typing import Callable, Iterator, Optional
+
+
+class Timer(ABC):
+    @abstractmethod
+    def poll(self, *, timeout_s: float, interval_s: float) -> Iterator[None]:
+        """Yield every interval_s until the timeout.
+
+        Exits when timeout_s is reached. DOES NOT raise TimeoutError.
+        """
+
+
+class RealTimer(Timer):
+    def poll(self, *, timeout_s: float, interval_s: float) -> Iterator[None]:
+        start_time_s = time.time()
+        while True:
+            yield
+
+            if time.time() - start_time_s >= timeout_s:
+                break
+            else:
+                time.sleep(interval_s)
+
+
+class FakeTimer(Timer):
+    def __init__(self):
+        self._on_poll_iteration: Optional[Callable[[int], None]] = None
+
+    def set_on_poll_iteration(self, on_poll_iteration: Callable[[int], None]):
+        self._on_poll_iteration = on_poll_iteration
+
+    def poll(self, *, timeout_s: float, interval_s: float) -> Iterator[None]:
+        iteration: int = 0
+        elapsed_time_s: float = 0
+        while True:
+            if self._on_poll_iteration is not None:
+                self._on_poll_iteration(iteration)
+            iteration += 1
+
+            yield
+
+            elapsed_time_s += interval_s
+            if elapsed_time_s >= timeout_s:
+                break

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/_private/workload/workload_sdk.py

@@ -7,7 +7,7 @@ from anyscale._private.anyscale_client import (
     AnyscaleClientInterface,
     WORKSPACE_CLUSTER_NAME_PREFIX,
 )
-from anyscale._private.sdk.base_sdk import BaseSDK
+from anyscale._private.sdk.base_sdk import BaseSDK, Timer
 from anyscale.cli_logger import BlockLogger
 from anyscale.compute_config._private.compute_config_sdk import ComputeConfigSDK
 from anyscale.compute_config.models import ComputeConfig
@@ -27,8 +27,9 @@ class WorkloadSDK(BaseSDK):
         *,
         logger: Optional[BlockLogger] = None,
         client: Optional[AnyscaleClientInterface] = None,
+        timer: Optional[Timer] = None,
     ):
-        super().__init__(logger=logger, client=client)
+        super().__init__(logger=logger, client=client, timer=timer)
         self._enable_image_build_for_tracked_requirements = (
             ENABLE_IMAGE_BUILD_FOR_TRACKED_REQUIREMENTS
         )

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/commands/machine_commands.py

@@ -18,8 +18,6 @@ def machine_cli() -> None:
 
 
 @machine_cli.command(name="list", help="List machines registered to Anyscale.")
-@click.option("--cloud", type=str, help="Provide a cloud name.")
-@click.option("--cloud-id", type=str, help="Provide a cloud ID.")
 @click.option("--machine-pool-name", type=str, help="Provide a machine pool name.")
 @click.option(
     "--format",
@@ -28,22 +26,9 @@ def machine_cli() -> None:
     default="table",
     help="The format to return results in.",
 )
-def list_machines(
-    cloud: Optional[str],
-    cloud_id: Optional[str],
-    machine_pool_name: Optional[str],
-    format_: str,
-) -> None:
-
-    if not cloud and not cloud_id and not machine_pool_name:
-        raise ValueError(
-            "One of {'cloud', 'cloud-id', 'machine-pool-name'} must be provided."
-        )
-
+def list_machines(machine_pool_name: str, format_: str,) -> None:
     machines_controller = MachineController()
-    output = machines_controller.list_machines(
-        cloud=cloud, cloud_id=cloud_id, machine_pool_name=machine_pool_name
-    )
+    output = machines_controller.list_machines(machine_pool_name)
 
     if format_ == "json":
         rows = []

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/commands/service_commands.py

@@ -11,7 +11,7 @@ from anyscale.cli_logger import BlockLogger
 from anyscale.commands.util import convert_kv_strings_to_dict
 from anyscale.controllers.service_controller import ServiceController
 import anyscale.service
-from anyscale.service import ServiceConfig, ServiceStatus
+from anyscale.service import ServiceConfig, ServiceState, ServiceStatus
 from anyscale.util import validate_non_negative_arg
 
 
@@ -312,6 +312,50 @@ def status(name: Optional[str], config_file: Optional[str], json: bool, verbose:
         print(stream.getvalue(), end="")
 
 
+@service_cli.command(
+    name="wait", help="Wait for a service to enter a target state.", hidden=True,
+)
+@click.option(
+    "-n", "--name", required=False, default=None, type=str, help="Name of the service.",
+)
+@click.option(
+    "-f",
+    "--config-file",
+    required=False,
+    default=None,
+    type=str,
+    help="Path to a YAML config file to read the name from.",
+)
+@click.option(
+    "-s",
+    "--state",
+    default=str(ServiceState.RUNNING),
+    help="The ServiceState to wait for the service to reach. Defaults to RUNNING.",
+)
+@click.option(
+    "-t",
+    "--timeout-s",
+    default=600,
+    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):
+    if name is not None and config_file is not None:
+        raise click.ClickException(
+            "Only one of '--name' and '--config-file' can be provided."
+        )
+
+    if config_file is not None:
+        name = _read_name_from_config_file(config_file)
+
+    if name is None:
+        raise click.ClickException(
+            "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)
+
+
 @service_cli.command(
     name="rollout", help="Roll out a service.",
 )
@@ -463,10 +507,7 @@ def rollback(
     config_file: Optional[str],
     max_surge_percent: Optional[int],
 ):
-    """Perform a rollback for a service that is currently in a rollout.
-
-    This *only* applies to v2 services.
-    """
+    """Perform a rollback for a service that is currently in a rollout."""
     service_controller = ServiceController()
     service_id = service_controller.get_service_id(
         service_id=service_id,

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/compute_config/__init__.py

@@ -1,4 +1,4 @@
-from anyscale.compute_config.commands import create, get
+from anyscale.compute_config.commands import archive, create, get
 from anyscale.compute_config.models import (
     ComputeConfig,
     HeadNodeConfig,

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/compute_config/_private/compute_config_sdk.py

@@ -346,3 +346,11 @@ class ComputeConfigSDK(BaseSDK):
         return self._convert_api_model_to_compute_config(
             self.client.get_compute_config(compute_config_id)
         )
+
+    def archive(self, name: str):
+        compute_config_id = self.client.get_compute_config_id(compute_config_name=name)
+        if compute_config_id is None:
+            raise RuntimeError(f"Compute config '{name}' was not found.")
+
+        self.client.archive_compute_config(compute_config_id=compute_config_id)
+        self.logger.info("Compute config is successfully archived.")

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/compute_config/commands.py

@@ -72,3 +72,24 @@ def get(name: str, *, _sdk: ComputeConfigSDK,) -> ComputeConfig:
     If no version is provided, the latest one will be returned.
     """
     return _sdk.get_compute_config(name=name)
+
+
+_ARCHIVE_EXAMPLE = """
+import anyscale
+
+anyscale.compute_config.archive(name="my-compute-config")
+"""
+
+
+@sdk_command(
+    _COMPUTE_CONFIG_SDK_SINGLETON_KEY,
+    ComputeConfigSDK,
+    doc_py_example=_ARCHIVE_EXAMPLE,
+    arg_docstrings={"name": "Name of the compute config."},
+)
+def archive(name: str = None, *, _sdk: ComputeConfigSDK) -> str:
+    """Archive a compute config.
+
+    Once a compute config is archived, its name will no longer be usable in the organization.
+    """
+    return _sdk.archive(name=name)

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/compute_config/models.py

@@ -345,7 +345,7 @@ compute_config:
         default=None,
         repr=False,
         metadata={
-            "docstring": "Total maximum logical resources across all nodes in the cluster. Resources omitted from this field have no maximum. Only supports 'CPU' and 'GPU' are currently supported."
+            "docstring": "Total maximum logical resources across all nodes in the cluster. Resources omitted from this field have no maximum. Only 'CPU' and 'GPU' resource limits are currently supported."
         },
     )
 

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/controllers/machine_controller.py

@@ -22,20 +22,9 @@ class MachineController(BaseController):
         self.log = log
         self.console = Console()
 
-    def list_machines(
-        self,
-        cloud: Optional[str],
-        cloud_id: Optional[str],
-        machine_pool_name: Optional[str],
-    ) -> ListMachinesResponse:
-        if cloud is not None or cloud_id is not None:
-            if cloud is not None:
-                cloud_id, _ = get_cloud_id_and_name(self.api_client, cloud_name=cloud)
-        elif machine_pool_name is not None:
-            machine_pool_name = machine_pool_name
-
+    def list_machines(self, machine_pool_name: str,) -> ListMachinesResponse:
         response: ListMachinesResponse = self.api_client.list_machines_api_v2_machines_get(
-            cloud_id=cloud_id, machine_pool_name=machine_pool_name,
+            machine_pool_name=machine_pool_name,
         ).result
         return response
 

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/service/__init__.py

@@ -1,2 +1,2 @@
-from anyscale.service.commands import deploy, rollback, status, terminate
+from anyscale.service.commands import deploy, rollback, status, terminate, wait
 from anyscale.service.models import ServiceConfig, ServiceState, ServiceStatus

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/service/_private/service_sdk.py

@@ -1,9 +1,8 @@
 import copy
-from typing import Any, Dict, Optional, Union
+from typing import Any, Dict, Optional
 
 from anyscale._private.models.image_uri import ImageURI
 from anyscale._private.workload import WorkloadSDK
-from anyscale.cli_logger import BlockLogger
 from anyscale.sdk.anyscale_client.models import (
     AccessConfig,
     ApplyServiceModel,
@@ -27,9 +26,6 @@ from anyscale.utils.workspace_notification import (
 )
 
 
-logger = BlockLogger()
-
-
 class ServiceSDK(WorkloadSDK):
     SERVICE_VERSION_ID_TRUNCATED_LEN = 8
 
@@ -456,6 +452,23 @@ class ServiceSDK(WorkloadSDK):
             ),
         )
 
+    def _model_state_to_state(
+        self, model_state: ServiceEventCurrentState,
+    ) -> ServiceState:
+        # If we add a new state to the backend, old clients may not recognize it.
+        # Rather than erroring out and causing old code to crash, return UNKNOWN.
+        state: ServiceState = ServiceState(ServiceState.UNKNOWN)
+        try:
+            state = ServiceState(model_state)
+        except ValueError:
+            self.logger.warning(
+                f"Got unrecognized state: '{model_state}'. "
+                "You likely need to update the 'anyscale' package. "
+                "If you still see this message after upgrading, contact Anyscale support."
+            )
+
+        return state
+
     def _service_model_to_status(self, model: ServiceModel) -> ServiceStatus:
         # TODO(edoakes): for some reason the primary_version is populated
         # when the service is terminated. This should be fixed in the backend.
@@ -482,22 +495,10 @@ class ServiceSDK(WorkloadSDK):
                 query_auth_token_enabled=query_auth_token_enabled,
             )
 
-        # If we add a new state to the backend, old clients may not recognize it.
-        # Rather than erroring out and causing old code to crash, return UNKNOWN.
-        state: Union[str, ServiceState] = ServiceState.UNKNOWN
-        try:
-            state = ServiceState(model.current_state)
-        except ValueError:
-            self.logger.warning(
-                f"Got unrecognized state: '{model.current_state}'. "
-                "You likely need to update the 'anyscale' package. "
-                "If you still see this message after upgrading, contact Anyscale support."
-            )
-
         return ServiceStatus(
             id=model.id,
             name=model.name,
-            state=state,
+            state=self._model_state_to_state(model.current_state),
             query_url=model.base_url,
             query_auth_token=model.auth_token,
             primary_version=primary_version,
@@ -510,3 +511,43 @@ class ServiceSDK(WorkloadSDK):
             raise RuntimeError(f"Service with name '{name}' was not found.")
 
         return self._service_model_to_status(model)
+
+    def wait(
+        self, name: str, *, state: ServiceState, timeout_s: float, interval_s: float,
+    ):
+        if not isinstance(timeout_s, (int, float)):
+            raise TypeError("timeout_s must be a float")
+        if timeout_s <= 0:
+            raise ValueError("timeout_s must be >= 0")
+
+        if not isinstance(interval_s, (int, float)):
+            raise TypeError("interval_s must be a float")
+        if interval_s <= 0:
+            raise ValueError("interval_s must be >= 0")
+
+        def _get_curr_state() -> ServiceState:
+            model: Optional[ServiceModel] = self.client.get_service(name)
+            if model is None:
+                raise RuntimeError(f"Service with name '{name}' was not found.")
+
+            return self._model_state_to_state(model.current_state)
+
+        curr_state = _get_curr_state()
+        self.logger.info(
+            f"Waiting for service '{name}' to reach target state {state}, currently in state: {curr_state}"
+        )
+        for _ in self.timer.poll(timeout_s=timeout_s, interval_s=interval_s):
+            new_state = _get_curr_state()
+            if new_state != curr_state:
+                self.logger.info(
+                    f"Service '{name}' transitioned from {curr_state} to {new_state}"
+                )
+                curr_state = new_state
+
+            if curr_state == state:
+                self.logger.info(f"Service '{name}' reached target state, exiting")
+                break
+        else:
+            raise TimeoutError(
+                f"Service '{name}' did not reach target state {state} within {timeout_s}s. Last seen state: {curr_state}."
+            )

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale/service/commands.py

@@ -1,8 +1,8 @@
-from typing import Optional
+from typing import Optional, Union
 
 from anyscale._private.sdk import sdk_command
 from anyscale.service._private.service_sdk import ServiceSDK
-from anyscale.service.models import ServiceConfig, ServiceStatus
+from anyscale.service.models import ServiceConfig, ServiceState, ServiceStatus
 
 
 _SERVICE_SDK_SINGLETON_KEY = "service_sdk"
@@ -132,3 +132,38 @@ status: ServiceStatus = anyscale.service.status(name="my-service")
 def status(name: str, *, _sdk: ServiceSDK) -> ServiceStatus:
     """Get the status of a service."""
     return _sdk.status(name=name)
+
+
+_WAIT_EXAMPLE = """
+import anyscale
+from anyscale.service.models import ServiceState
+
+anyscale.service.wait(name="my-service", state=ServiceState.RUNNING)
+"""
+
+
+@sdk_command(
+    _SERVICE_SDK_SINGLETON_KEY,
+    ServiceSDK,
+    doc_py_example=_WAIT_EXAMPLE,
+    arg_docstrings={
+        "name": "Name of the service.",
+        "state": "The state to wait for the service to reach.",
+        "timeout_s": "Timeout to wait for the service to reach the target state.",
+    },
+)
+def wait(
+    name: str,
+    *,
+    state: Union[str, ServiceState] = ServiceState.RUNNING,
+    timeout_s: float = 600,
+    _sdk: ServiceSDK,
+    _interval_s: float = 5,
+):
+    """Wait for a service to reach a target state."""
+    return _sdk.wait(
+        name=name,
+        state=ServiceState(state),
+        timeout_s=timeout_s,
+        interval_s=_interval_s,
+    )

anyscale-0.24.28/anyscale/version.py

@@ -0,0 +1 @@
+__version__ = "0.24.28"

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale.egg-info/PKG-INFO

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

{anyscale-0.24.27 → anyscale-0.24.28}/anyscale.egg-info/SOURCES.txt

@@ -56,6 +56,7 @@ anyscale/_private/models/image_uri.py
 anyscale/_private/models/model_base.py
 anyscale/_private/sdk/__init__.py
 anyscale/_private/sdk/base_sdk.py
+anyscale/_private/sdk/timer.py
 anyscale/_private/workload/__init__.py
 anyscale/_private/workload/workload_config.py
 anyscale/_private/workload/workload_sdk.py

{anyscale-0.24.27 → anyscale-0.24.28}/tests/controllers/test_machine_controller.py

@@ -29,7 +29,5 @@ def test_list_machines(mock_auth_api_client: str) -> None:
     machine_controller.api_client.list_machines_api_v2_machines_get = Mock(
         return_value=api_response
     )
-    output = machine_controller.list_machines(
-        cloud_id=None, cloud=None, machine_pool_name="pool1"
-    )
+    output = machine_controller.list_machines(machine_pool_name="pool1")
     assert output == response