anyscale 0.26.52__py3-none-any.whl → 0.26.54__py3-none-any.whl

anyscale/commands/workspace_commands.py

@@ -11,8 +11,7 @@ from anyscale.cli_logger import BlockLogger
 from anyscale.client.openapi_client.models.execute_interactive_command_options import (
     ExecuteInteractiveCommandOptions,
 )
-from anyscale.commands import workspace_commands_v2
-from anyscale.commands.util import LegacyAnyscaleCommand
+from anyscale.commands.util import DeprecatedAnyscaleCommand, LegacyAnyscaleCommand
 from anyscale.controllers.cluster_controller import ClusterController
 from anyscale.controllers.workspace_controller import WorkspaceController
 from anyscale.project_utils import find_project_root
@@ -34,10 +33,11 @@ def workspace_cli() -> None:
 
 @workspace_cli.command(
     name="create",
-    help="Create a workspace on Anyscale.",
-    cls=LegacyAnyscaleCommand,
-    new_prefix="anyscale workspace_v2",
-    new_cli=workspace_commands_v2.create,
+    help="[DEPRECATED - use 'workspace_v2 create' instead] Create a workspace on Anyscale.",
+    cls=DeprecatedAnyscaleCommand,
+    removal_date="2025-10-01",
+    deprecation_message="The workspace v1 CLI is being replaced",
+    alternative="use 'anyscale workspace_v2 create' instead",
 )
 @click.option(
     "--name", "-n", required=True, help="Name of the workspace to create.",
@@ -85,6 +85,11 @@ def create(  # noqa: PLR0913
     ray_version: str,
     compute_config_id: str,
 ) -> None:
+    """Create a workspace on Anyscale.
+
+    DEPRECATED: This command will be removed on 2025-10-01.
+    Use 'anyscale workspace_v2 create' instead.
+    """
     if cluster_env_build_id is None and docker is None:
         raise click.ClickException(
             "Please specify one of `--docker` or `--cluster-env-build-id`."
@@ -121,15 +126,21 @@ def create(  # noqa: PLR0913
 
 @workspace_cli.command(
     name="start",
-    help="Start an existing workspace on Anyscale.",
-    cls=LegacyAnyscaleCommand,
-    new_prefix="anyscale workspace_v2",
-    new_cli=workspace_commands_v2.start,
+    help="[DEPRECATED - use 'workspace_v2 start' instead] Start an existing workspace on Anyscale.",
+    cls=DeprecatedAnyscaleCommand,
+    removal_date="2025-10-01",
+    deprecation_message="The workspace v1 CLI is being replaced",
+    alternative="use 'anyscale workspace_v2 start' instead",
 )
 @click.option(
     "--name", "-n", required=True, help="Name of existing workspace to start.",
 )
 def start(name: str) -> None:
+    """Start an existing workspace on Anyscale.
+
+    DEPRECATED: This command will be removed on 2025-10-01.
+    Use 'anyscale workspace_v2 start' instead.
+    """
     cluster_controller = ClusterController()
 
     workspace = get_workspace_from_name(name)
@@ -154,15 +165,21 @@ def start(name: str) -> None:
 
 @workspace_cli.command(
     name="terminate",
-    help="Terminate a workspace on Anyscale.",
-    cls=LegacyAnyscaleCommand,
-    new_prefix="anyscale workspace_v2",
-    new_cli=workspace_commands_v2.terminate,
+    help="[DEPRECATED - use 'workspace_v2 terminate' instead] Terminate a workspace on Anyscale.",
+    cls=DeprecatedAnyscaleCommand,
+    removal_date="2025-10-01",
+    deprecation_message="The workspace v1 CLI is being replaced",
+    alternative="use 'anyscale workspace_v2 terminate' instead",
 )
 @click.option(
     "--name", "-n", required=True, help="Name of existing workspace to terminate.",
 )
 def terminate(name: str) -> None:
+    """Terminate a workspace on Anyscale.
+
+    DEPRECATED: This command will be removed on 2025-10-01.
+    Use 'anyscale workspace_v2 terminate' instead.
+    """
     cluster_controller = ClusterController()
     workspace = get_workspace_from_name(name)
     cluster_id = workspace.cluster_id
@@ -179,9 +196,11 @@ def terminate(name: str) -> None:
 
 @workspace_cli.command(
     name="clone",
-    help="Clone a workspace on Anyscale.",
-    cls=LegacyAnyscaleCommand,
-    is_limited_support=True,
+    help="[DEPRECATED - use workspace_v2 clone functionality instead] Clone a workspace on Anyscale.",
+    cls=DeprecatedAnyscaleCommand,
+    removal_date="2025-10-01",
+    deprecation_message="The workspace v1 CLI is being replaced",
+    alternative="use workspace_v2 clone functionality instead",
 )
 @click.option(
     "--name", "-n", required=True, help="Name of existing workspace to clone.",
@@ -190,8 +209,10 @@ def terminate(name: str) -> None:
     "--verbose", "-v", required=False, is_flag=True, default=False, help="Verbose mode"
 )
 def clone(name: str, verbose: bool) -> None:
-    """
-    Clone the workspace to a local dir whose name is the name of the workspace.
+    """Clone the workspace to a local dir whose name is the name of the workspace.
+
+    DEPRECATED: This command will be removed on 2025-10-01.
+    Use workspace_v2 clone functionality instead.
     """
     _check_local()
 
@@ -207,13 +228,24 @@ def clone(name: str, verbose: bool) -> None:
     _do_pull(pull_git_state=True, verbose=verbose)
 
 
-@workspace_cli.command(name="activate")
+@workspace_cli.command(
+    name="activate",
+    help="[DEPRECATED - no longer needed] Activate a workspace.",
+    cls=DeprecatedAnyscaleCommand,
+    removal_date="2025-10-01",
+    deprecation_message="The workspace v1 activate command is no longer needed",
+    alternative="use workspace_v2 commands which don't require activation",
+)
 @click.argument(
     "name", required=True, default=None,
 )
 def activate(name: str) -> None:
     """Activate a workspace.
 
+    DEPRECATED: This command will be removed on 2025-10-01.
+    The workspace v1 activate command is no longer needed.
+    Use workspace_v2 commands which don't require activation.
+
     If the current directory is already a part of a workspace, change the workspace.
     Else, setup a new workspace rooted at the current directory
 
@@ -239,10 +271,11 @@ def activate(name: str) -> None:
 
 @workspace_cli.command(
     name="pull",
-    help="Pull files from a workspace on Anyscale.",
-    cls=LegacyAnyscaleCommand,
-    new_prefix="anyscale workspace_v2",
-    new_cli=workspace_commands_v2.pull,
+    help="[DEPRECATED - use 'workspace_v2 pull' instead] Pull files from a workspace on Anyscale.",
+    cls=DeprecatedAnyscaleCommand,
+    removal_date="2025-10-01",
+    deprecation_message="The workspace v1 CLI is being replaced",
+    alternative="use 'anyscale workspace_v2 pull' instead",
 )
 @click.option(
     "--pull-git-state",
@@ -252,6 +285,11 @@ def activate(name: str) -> None:
     help="Also pull git state. This will add additional overhead.",
 )
 def pull(pull_git_state) -> None:
+    """Pull files from a workspace on Anyscale.
+
+    DEPRECATED: This command will be removed on 2025-10-01.
+    Use 'anyscale workspace_v2 pull' instead.
+    """
     _check_local()
     _check_workspace()
     _do_pull(pull_git_state)
@@ -259,10 +297,11 @@ def pull(pull_git_state) -> None:
 
 @workspace_cli.command(
     name="push",
-    help="Push files to a workspace on Anyscale.",
-    cls=LegacyAnyscaleCommand,
-    new_prefix="anyscale workspace_v2",
-    new_cli=workspace_commands_v2.push,
+    help="[DEPRECATED - use 'workspace_v2 push' instead] Push files to a workspace on Anyscale.",
+    cls=DeprecatedAnyscaleCommand,
+    removal_date="2025-10-01",
+    deprecation_message="The workspace v1 CLI is being replaced",
+    alternative="use 'anyscale workspace_v2 push' instead",
 )
 @click.option(
     "--push-git-state",
@@ -272,6 +311,11 @@ def pull(pull_git_state) -> None:
     help="Also push git state. This is currently unoptimized and will be very slow.",
 )
 def push(push_git_state) -> None:
+    """Push files to a workspace on Anyscale.
+
+    DEPRECATED: This command will be removed on 2025-10-01.
+    Use 'anyscale workspace_v2 push' instead.
+    """
     _check_local()
     _check_workspace()
     _do_push(push_git_state)
@@ -279,10 +323,11 @@ def push(push_git_state) -> None:
 
 @workspace_cli.command(
     name="run",
-    help="Run a command in a workspace, syncing files first if needed.",
-    cls=LegacyAnyscaleCommand,
-    new_prefix="anyscale workspace_v2",
-    new_cli=workspace_commands_v2.run_command,
+    help="[DEPRECATED - use 'workspace_v2 run_command' instead] Run a command in a workspace, syncing files first if needed.",
+    cls=DeprecatedAnyscaleCommand,
+    removal_date="2025-10-01",
+    deprecation_message="The workspace v1 CLI is being replaced",
+    alternative="use 'anyscale workspace_v2 run_command' instead",
 )
 @click.argument("command", required=True)
 @click.option(
@@ -310,6 +355,11 @@ def push(push_git_state) -> None:
     help="Whether to skip pushing files prior to running the command.",
 )
 def run(command: str, web_terminal: bool, as_job: bool, no_push: bool,) -> None:
+    """Run a command in a workspace, syncing files first if needed.
+
+    DEPRECATED: This command will be removed on 2025-10-01.
+    Use 'anyscale workspace_v2 run_command' instead.
+    """
     _check_local()
     _check_workspace()
     if as_job:
@@ -337,17 +387,20 @@ def run(command: str, web_terminal: bool, as_job: bool, no_push: bool,) -> None:
 
 @workspace_cli.command(
     name="ssh",
-    help="ssh into a workspace, you can also pass args to the ssh command. E.g. 'anyscale workspace ssh -- -L 8888:localhost:8888",
-    cls=LegacyAnyscaleCommand,
-    new_cli=workspace_commands_v2.ssh,
-    new_prefix="anyscale workspace_v2",
+    help="[DEPRECATED - use 'workspace_v2 ssh' instead] ssh into a workspace, you can also pass args to the ssh command. E.g. 'anyscale workspace ssh -- -L 8888:localhost:8888",
+    cls=DeprecatedAnyscaleCommand,
+    removal_date="2025-10-01",
+    deprecation_message="The workspace v1 CLI is being replaced",
+    alternative="use 'anyscale workspace_v2 ssh' instead",
 )
 @click.argument(
     "args", nargs=-1, required=False, type=click.UNPROCESSED,
 )
 def ssh(args: Tuple[str]) -> None:
-    """
-    ssh into a running workspace.
+    """ssh into a running workspace.
+
+    DEPRECATED: This command will be removed on 2025-10-01.
+    Use 'anyscale workspace_v2 ssh' instead.
     """
     _check_local()
 
@@ -364,6 +417,7 @@ def list_command() -> None:
     workspace_controller.list()
 
 
+# TODO(vigneshka): Migrate to v2 if there is usage, then deprecate
 @workspace_cli.command(name="cp", cls=LegacyAnyscaleCommand, is_limited_support=True)
 @click.argument(
     "remote_path",

anyscale/compute_config/__init__.py

@@ -21,7 +21,7 @@ from anyscale.compute_config.models import (
     ComputeConfigType,
     ComputeConfigVersion,
     HeadNodeConfig,
-    MultiDeploymentComputeConfig,
+    MultiResourceComputeConfig,
     WorkerNodeGroupConfig,
 )
 

anyscale/compute_config/_private/compute_config_sdk.py

@@ -20,7 +20,7 @@ from anyscale.compute_config.models import (
     ComputeConfigVersion,
     HeadNodeConfig,
     MarketType,
-    MultiDeploymentComputeConfig,
+    MultiResourceComputeConfig,
     WorkerNodeGroupConfig,
 )
 from anyscale.sdk.anyscale_client.models import ClusterComputeConfig
@@ -148,7 +148,7 @@ class PrivateComputeConfigSDK(BaseSDK):
             flags["max_resources"] = compute_config.max_resources
 
         return CloudDeploymentComputeConfig(
-            cloud_deployment=compute_config.cloud_deployment,
+            cloud_deployment=compute_config.cloud_resource,
             allowed_azs=compute_config.zones,
             head_node_type=self._convert_head_node_config_to_api_model(
                 compute_config.head_node,
@@ -180,7 +180,7 @@ class PrivateComputeConfigSDK(BaseSDK):
                     "The latest version tag will be generated and returned."
                 )
 
-        if isinstance(compute_config, MultiDeploymentComputeConfig):
+        if isinstance(compute_config, MultiResourceComputeConfig):
             return self.create_multi_deployment_compute_config(
                 compute_config, name=name
             )
@@ -226,10 +226,7 @@ class PrivateComputeConfigSDK(BaseSDK):
         return full_name, compute_config_id
 
     def create_multi_deployment_compute_config(
-        self,
-        compute_config: MultiDeploymentComputeConfig,
-        *,
-        name: Optional[str] = None,
+        self, compute_config: MultiResourceComputeConfig, *, name: Optional[str] = None,
     ) -> Tuple[str, str]:
         """Register the provided multi-deployment compute config and return its internal ID."""
         # Returns the default cloud if user-provided cloud is not specified (`None`).
@@ -381,7 +378,7 @@ class PrivateComputeConfigSDK(BaseSDK):
 
         return configs
 
-    def _convert_cloud_deployment_compute_config_api_model_to_single_deployment_compute_config(
+    def _convert_cloud_deployment_compute_config_api_model_to_single_resource_compute_config(
         self, cloud_name: str, api_model: CloudDeploymentComputeConfig,
     ) -> ComputeConfig:
         worker_nodes = None
@@ -416,7 +413,7 @@ class PrivateComputeConfigSDK(BaseSDK):
 
         return ComputeConfig(
             cloud=cloud_name,
-            cloud_deployment=api_model.cloud_deployment,
+            cloud_resource=api_model.cloud_deployment,
             zones=zones,
             advanced_instance_config=api_model.advanced_configurations_json or None,
             enable_cross_zone_scaling=enable_cross_zone_scaling,
@@ -443,7 +440,7 @@ class PrivateComputeConfigSDK(BaseSDK):
         configs = None
         if api_model_config.deployment_configs:
             configs = [
-                self._convert_cloud_deployment_compute_config_api_model_to_single_deployment_compute_config(
+                self._convert_cloud_deployment_compute_config_api_model_to_single_resource_compute_config(
                     cloud.name, config
                 )
                 for config in api_model_config.deployment_configs
@@ -458,7 +455,7 @@ class PrivateComputeConfigSDK(BaseSDK):
             return ComputeConfigVersion(
                 name=f"{api_model.name}:{api_model.version}",
                 id=api_model.id,
-                config=MultiDeploymentComputeConfig(cloud=cloud.name, configs=configs),
+                config=MultiResourceComputeConfig(cloud=cloud.name, configs=configs),
             )
 
         # If there are no deployment configs, this is a compute config for a single cloud deployment - parse the top-level fields.

anyscale/compute_config/commands.py

@@ -34,10 +34,10 @@ single_deployment_compute_config = ComputeConfig(
 )
 full_name: str = anyscale.compute_config.create(single_deployment_compute_config, name="my-single-deployment-compute-config")
 
-multi_deployment_compute_config = MultiDeploymentComputeConfig(
+multi_deployment_compute_config = MultiResourceComputeConfig(
     configs=[
         ComputeConfig(
-            cloud_deployment="vm-aws-us-west-1",
+            cloud_resource="vm-aws-us-west-1",
             head_node=HeadNodeConfig(
                 instance_type="m5.2xlarge",
             ),
@@ -50,7 +50,7 @@ multi_deployment_compute_config = MultiDeploymentComputeConfig(
             ],
         ),
         ComputeConfig(
-            cloud_deployment="vm-aws-us-west-2",
+            cloud_resource="vm-aws-us-west-2",
             head_node=HeadNodeConfig(
                 instance_type="m5.2xlarge",
             ),

anyscale/compute_config/models.py

@@ -315,7 +315,7 @@ worker_nodes:
 
 @dataclass(frozen=True)
 class ComputeConfig(ModelBase):
-    """Compute configuration for instance types and cloud resources for a cluster with a single cloud deployment."""
+    """Compute configuration for instance types and cloud resources for a cluster with a single cloud resource."""
 
     __doc_py_example__ = """
 from anyscale.compute_config.models import (
@@ -417,18 +417,18 @@ advanced_instance_config: # (Optional) Defaults to no advanced configurations.
         if cloud is not None and not isinstance(cloud, str):
             raise TypeError("'cloud' must be a string")
 
-    cloud_deployment: Optional[str] = field(
+    cloud_resource: Optional[str] = field(
         default=None,
         repr=False,
         metadata={
-            "docstring": "The cloud deployment to use for this workload. Defaults to the primary deployment of the Cloud.",
+            "docstring": "The cloud resource to use for this workload. Defaults to the primary cloud resource of the Cloud.",
             "customer_hosted_only": True,
         },
     )
 
-    def _validate_cloud_deployment(self, cloud_deployment: Optional[str]):
-        if cloud_deployment is not None and not isinstance(cloud_deployment, str):
-            raise TypeError("'cloud_deployment' must be a string")
+    def _validate_cloud_resource(self, cloud_resource: Optional[str]):
+        if cloud_resource is not None and not isinstance(cloud_resource, str):
+            raise TypeError("'cloud_resource' must be a string")
 
     head_node: Union[HeadNodeConfig, Dict, None] = field(
         default=None,
@@ -600,18 +600,18 @@ advanced_instance_config: # (Optional) Defaults to no advanced configurations.
 
 
 @dataclass(frozen=True)
-class MultiDeploymentComputeConfig(ModelBase):
-    """EXPERIMENTAL. Compute configuration for a cluster with multiple possible cloud deployments."""
+class MultiResourceComputeConfig(ModelBase):
+    """EXPERIMENTAL. Compute configuration for a cluster with multiple possible cloud resources."""
 
     __doc_py_example__ = """
 from anyscale.compute_config.models import (
-    MultiDeploymentComputeConfig, ComputeConfig, HeadNodeConfig, WorkerNodeGroupConfig
+    MultiResourceComputeConfig, ComputeConfig, HeadNodeConfig, WorkerNodeGroupConfig
 )
-config = MultiDeploymentComputeConfig(
+config = MultiResourceComputeConfig(
     cloud="my-cloud",
     configs=[
         ComputeConfig(
-            cloud_deployment="vm-aws-us-west-1",
+            cloud_resource="vm-aws-us-west-1",
             head_node=HeadNodeConfig(
                 instance_type="m5.2xlarge",
             ),
@@ -624,7 +624,7 @@ config = MultiDeploymentComputeConfig(
             ],
         ),
         ComputeConfig(
-            cloud_deployment="vm-aws-us-west-2",
+            cloud_resource="vm-aws-us-west-2",
             head_node=HeadNodeConfig(
                 instance_type="m5.2xlarge",
             ),
@@ -643,14 +643,14 @@ config = MultiDeploymentComputeConfig(
     __doc_yaml_example__ = """
 cloud: my-cloud
 configs:
-- cloud_deployment: vm-aws-us-west-1
+- cloud_resource: vm-aws-us-west-1
   head_node:
     instance_type: m5.2xlarge
   worker_nodes:
   - instance_type: m5.4xlarge
     min_nodes: 1
     max_nodes: 10
-- cloud_deployment: vm-aws-us-west-2
+- cloud_resource: vm-aws-us-west-2
   head_node:
     instance_type: m5.2xlarge
   worker_nodes:
@@ -673,7 +673,7 @@ configs:
         default_factory=list,
         repr=False,
         metadata={
-            "docstring": "List of compute configurations, one for each cloud deployment.",
+            "docstring": "List of compute configurations, one for each cloud resource.",
             "customer_hosted_only": True,
         },
     )
@@ -690,7 +690,7 @@ configs:
 
         config_models: List[ComputeConfig] = []
         unique_clouds = set()
-        unique_deployments = set()
+        unique_resources = set()
         for config in configs:
             if isinstance(config, dict):
                 config = ComputeConfig.from_dict(config)
@@ -701,14 +701,14 @@ configs:
             if config.cloud:
                 unique_clouds.add(config.cloud)
 
-            unique_deployments.add(config.cloud_deployment)
+            unique_resources.add(config.cloud_resource)
 
         if len(unique_clouds) > 1:
             raise ValueError("'cloud' must be the same for all configs.")
 
-        if len(unique_deployments) != len(configs):
+        if len(unique_resources) != len(configs):
             raise ValueError(
-                "'cloud_deployment' must be unique for each compute configuration."
+                "'cloud_resource' must be unique for each compute configuration."
             )
 
         if len(configs) == 0:
@@ -719,14 +719,14 @@ configs:
         return config_models
 
 
-ComputeConfigType = Union[ComputeConfig, MultiDeploymentComputeConfig]
+ComputeConfigType = Union[ComputeConfig, MultiResourceComputeConfig]
 
 
 def compute_config_type_from_yaml(config_file: str) -> ComputeConfigType:
     """
-    Parse a YAML compute config file into either a ComputeConfig or MultiDeploymentComputeConfig.
+    Parse a YAML compute config file into either a ComputeConfig or MultiResourceComputeConfig.
     """
-    error_message = f"Could not parse config file '{config_file}' as a ComputeConfig or MultiDeploymentComputeConfig:\n"
+    error_message = f"Could not parse config file '{config_file}' as a ComputeConfig or MultiResourceComputeConfig:\n"
 
     try:
         return ComputeConfig.from_yaml(config_file)
@@ -734,18 +734,18 @@ def compute_config_type_from_yaml(config_file: str) -> ComputeConfigType:
         error_message += f"ComputeConfig: {e}\n"
 
     try:
-        return MultiDeploymentComputeConfig.from_yaml(config_file)
+        return MultiResourceComputeConfig.from_yaml(config_file)
     except Exception as e:  # noqa: BLE001
-        error_message += f"MultiDeploymentComputeConfig: {e}\n"
+        error_message += f"MultiResourceComputeConfig: {e}\n"
 
     raise TypeError(error_message.rstrip())
 
 
 def compute_config_type_from_dict(config_dict: Dict) -> ComputeConfigType:
     """
-    Parse a compute config dict into either a ComputeConfig or MultiDeploymentComputeConfig.
+    Parse a compute config dict into either a ComputeConfig or MultiResourceComputeConfig.
     """
-    error_message = f"Could not parse config dict '{config_dict}' as a ComputeConfig or MultiDeploymentComputeConfig:\n"
+    error_message = f"Could not parse config dict '{config_dict}' as a ComputeConfig or MultiResourceComputeConfig:\n"
 
     try:
         return ComputeConfig.from_dict(config_dict)
@@ -753,9 +753,9 @@ def compute_config_type_from_dict(config_dict: Dict) -> ComputeConfigType:
         error_message += f"ComputeConfig: {e}\n"
 
     try:
-        return MultiDeploymentComputeConfig.from_dict(config_dict)
+        return MultiResourceComputeConfig.from_dict(config_dict)
     except Exception as e:  # noqa: BLE001
-        error_message += f"MultiDeploymentComputeConfig: {e}\n"
+        error_message += f"MultiResourceComputeConfig: {e}\n"
 
     raise TypeError(error_message.rstrip())
 
@@ -819,8 +819,8 @@ config:
 
     def _validate_config(self, config: Optional[ComputeConfigType]):
         if config is not None and not isinstance(
-            config, (ComputeConfig, MultiDeploymentComputeConfig)
+            config, (ComputeConfig, MultiResourceComputeConfig)
         ):
             raise TypeError(
-                "'config' must be a ComputeConfig or MultiDeploymentComputeConfig"
+                "'config' must be a ComputeConfig or MultiResourceComputeConfig"
             )