anyscale 0.26.51__py3-none-any.whl → 0.26.53__py3-none-any.whl

anyscale/cloud/models.py

@@ -222,15 +222,6 @@ cloud = Cloud(
         return is_aggregated_logs_enabled
 
 
-################################################################################
-# NOTE: The models below are copied from the OpenAPI CloudDeployment model, which
-# is what is used in the CLI. They are only defined here so that they appear in
-# the generated docs, to provide users with examples of the expected
-# CloudDeployment YAML format. There is no SDK support for Cloud Deployments,
-# nor is there SDK support for creating/updating/deleting Clouds.
-################################################################################
-
-
 class NetworkingMode(ModelEnum):
     PUBLIC = "PUBLIC"
     PRIVATE = "PRIVATE"
@@ -275,13 +266,13 @@ object_storage:
     bucket_name: Optional[str] = field(
         default=None,
         metadata={
-            "docstring": "The cloud storage bucket name, prefixed with the storage scheme (s3://bucket-name, gs://bucket-name, or azure://bucket-name)."
+            "docstring": "The cloud storage bucket name, prefixed with the storage scheme (s3://bucket-name, gs://bucket-name, or abfss://bucket-name@account.dfs.core.windows.net)."
         },
     )
     region: Optional[str] = field(
         default=None,
         metadata={
-            "docstring": "The region for the cloud storage bucket. Defaults to the region of the deployment."
+            "docstring": "The region for the cloud storage bucket. Defaults to the region of the cloud resource."
         },
     )
     endpoint: Optional[str] = field(
@@ -321,13 +312,13 @@ file_storage:
     persistent_volume_claim: Optional[str] = field(
         default=None,
         metadata={
-            "docstring": "For Kubernetes deployments, the name of the persistent volume claim used to mount shared storage into pods."
+            "docstring": "For Kubernetes resources, the name of the persistent volume claim used to mount shared storage into pods."
         },
     )
     csi_ephemeral_volume_driver: Optional[str] = field(
         default=None,
         metadata={
-            "docstring": "For Kubernetes deployments, the CSI ephemeral volume driver used to mount shared storage into pods."
+            "docstring": "For Kubernetes resources, the CSI ephemeral volume driver used to mount shared storage into pods."
         },
     )
 
@@ -390,7 +381,7 @@ aws_config:
     cloudformation_id: Optional[str] = field(
         default=None,
         metadata={
-            "docstring": "The CloudFormation stack ID, for deployments with Anyscale-managed resources."
+            "docstring": "The CloudFormation stack ID, for Anyscale-managed resources."
         },
     )
 
@@ -452,7 +443,7 @@ gcp_config:
     deployment_manager_id: Optional[str] = field(
         default=None,
         metadata={
-            "docstring": "The deployment manager deployment ID, for deployments with Anyscale-managed resources."
+            "docstring": "The deployment manager deployment ID, for Anyscale-managed resources."
         },
     )
 
@@ -483,41 +474,48 @@ kubernetes_config:
     )
 
 
+################################################################################
+# NOTE: The CloudResource model below is copied from the OpenAPI CloudDeployment
+# model, which is what is actually used in the CLI. It is only defined here so
+# that it appears in the generated docs, to provide users with examples of the
+# expected YAML format. There is no CloudResource SDK support, so the name of
+# this model should not actually matter. (There is also no Cloud SDK support.)
+################################################################################
 @dataclass(frozen=True)
-class CloudDeployment(ModelBase):
-    """Cloud deployment configuration."""
+class CloudResource(ModelBase):
+    """Cloud resource configuration."""
 
     __skip_py_example__ = True
 
     __doc_yaml_example__ = """\
-cloud_deployment:
-  cloud_deployment_id: cldrsrc_12345678901234567890123456
-  name: my-cloud-deployment
-  provider: AWS
-  compute_stack: VM
-  region: us-west-2
-  networking_mode: PUBLIC
-  object_storage:
-    bucket_name: s3://my-bucket
-  file_storage:
-    file_storage_id: fs-12345678901234567
-  aws_config:
-    vpc_id: vpc-12345678901234567
-    subnet_ids:
-      - subnet-11111111111111111
-      - subnet-22222222222222222
-    security_group_ids:
-      - sg-12345678901234567
-    anyscale_iam_role_id: arn:aws:iam::123456789012:role/anyscale-iam-role
-    cluster_iam_role_id: arn:aws:iam::123456789012:role/cluster-node-role
-    memorydb_cluster_name: my-memorydb-cluster
+cloud_resource_id: cldrsrc_12345678901234567890123456
+name: my-cloud-resource
+provider: AWS
+compute_stack: VM
+region: us-west-2
+networking_mode: PUBLIC
+object_storage:
+bucket_name: s3://my-bucket
+file_storage:
+file_storage_id: fs-12345678901234567
+aws_config:
+vpc_id: vpc-12345678901234567
+subnet_ids:
+    - subnet-11111111111111111
+    - subnet-22222222222222222
+security_group_ids:
+    - sg-12345678901234567
+anyscale_iam_role_id: arn:aws:iam::123456789012:role/anyscale-iam-role
+cluster_iam_role_id: arn:aws:iam::123456789012:role/cluster-node-role
+memorydb_cluster_name: my-memorydb-cluster
 """
 
-    cloud_deployment_id: Optional[str] = field(
-        default=None, metadata={"docstring": "Unique identifier for this deployment."},
+    cloud_resource_id: Optional[str] = field(
+        default=None,
+        metadata={"docstring": "Unique identifier for this cloud resource."},
     )
     name: Optional[str] = field(
-        default=None, metadata={"docstring": "The name of this deployment."},
+        default=None, metadata={"docstring": "The name of this cloud resource."},
     )
     provider: Union[CloudProvider, str] = field(
         default=CloudProvider.UNKNOWN,
@@ -528,8 +526,7 @@ cloud_deployment:
         metadata={"docstring": "The compute stack (VM or K8S)."},
     )
     region: Optional[str] = field(
-        default=None,
-        metadata={"docstring": "The region for the deployment (e.g., us-west-2)."},
+        default=None, metadata={"docstring": "The region (e.g., us-west-2)."},
     )
     networking_mode: Optional[NetworkingMode] = field(
         default=None,

anyscale/commands/cloud_commands.py

@@ -244,8 +244,8 @@ def list_cloud(name: Optional[str], cloud_id: Optional[str], max_items: int,) ->
     )
 
 
-@cloud_cli.group("deployment", help="Manage the configuration for a cloud deployment.")
-def cloud_deployment_group() -> None:
+@cloud_cli.group("resource", help="Manage the configuration for a cloud resource.")
+def cloud_resource_group() -> None:
     pass
 
 
@@ -254,138 +254,74 @@ def cloud_config_group() -> None:
     pass
 
 
-@cloud_deployment_group.command(
+@cloud_resource_group.command(
     name="create",
-    help="Create a new cloud deployment in an existing cloud.",
+    help="Create a new cloud resource in an existing cloud.",
     cls=AnyscaleCommand,
-    example=command_examples.CLOUD_DEPLOYMENT_CREATE_EXAMPLE,
+    example=command_examples.CLOUD_RESOURCE_CREATE_EXAMPLE,
     is_alpha=True,
 )
 @click.option(
     "--cloud",
-    help="The name of the cloud to create the new deployment in.",
-    type=str,
-    required=True,
-)
-@click.option(
-    "--file", "-f", help="YAML file containing the deployment spec.", required=True,
-)
-@click.option(
-    "--skip-verification",
-    is_flag=True,
-    default=False,
-    help="Skip cloud deployment verification.",
-)
-@click.option(
-    "--yes", "-y", is_flag=True, default=False, help="Skip asking for confirmation."
-)
-def cloud_deployment_create(
-    cloud: str, file: str, skip_verification: bool, yes: bool,
-) -> None:
-    try:
-        CloudController().create_cloud_deployment(cloud, file, skip_verification, yes)
-    except click.ClickException as e:
-        print(e)
-
-
-@cloud_deployment_group.command(
-    name="get",
-    help="Get a cloud deployment for a cloud.",
-    cls=AnyscaleCommand,
-    example=command_examples.CLOUD_DEPLOYMENT_GET_EXAMPLE,
-    is_alpha=True,
-)
-@click.option(
-    "--cloud",
-    help="The name of the cloud that the cloud deployment belongs to.",
-    type=str,
-    required=True,
-)
-@click.option(
-    "--deployment",
-    help="The name of the cloud deployment. If not provided, the primary cloud deployment will be returned.",
-    type=str,
-    required=False,
-)
-def cloud_deployment_get(cloud: str, deployment: Optional[str]) -> None:
-    try:
-        result = CloudController().get_cloud_deployment_dict_by_name(cloud, deployment)
-        print(yaml.dump(result, sort_keys=False))
-    except click.ClickException as e:
-        print(e)
-
-
-@cloud_deployment_group.command(
-    name="update",
-    help="Update a cloud deployment in an existing cloud.",
-    cls=AnyscaleCommand,
-    example=command_examples.CLOUD_DEPLOYMENT_UPDATE_EXAMPLE,
-    is_alpha=True,
-)
-@click.option(
-    "--cloud",
-    help="The name of the cloud that the cloud deployment belongs to.",
+    help="The name of the cloud to add the new resource to.",
     type=str,
     required=True,
 )
 @click.option(
     "--file",
     "-f",
-    help="Path to a YAML file defining the cloud deployment. Schema: https://docs.anyscale.com/reference/cloud-api#clouddeployment.",  # TODO(janet): check link
+    help="Path to a YAML file defining the cloud resource. Schema: https://docs.anyscale.com/reference/cloud/#cloudresource.",
     required=True,
 )
 @click.option(
     "--skip-verification",
     is_flag=True,
     default=False,
-    help="Skip cloud deployment verification.",
+    help="Skip cloud resource verification.",
 )
 @click.option(
     "--yes", "-y", is_flag=True, default=False, help="Skip asking for confirmation."
 )
-def cloud_deployment_update(
-    cloud: str, file: str, skip_verification: bool, yes: bool
+def cloud_resource_create(
+    cloud: str, file: str, skip_verification: bool, yes: bool,
 ) -> None:
     try:
-        CloudController().update_cloud_deployment(cloud, file, skip_verification, yes)
+        CloudController().create_cloud_resource(cloud, file, skip_verification, yes)
     except click.ClickException as e:
         print(e)
 
 
-@cloud_deployment_group.command(
+@cloud_resource_group.command(
     name="delete",
-    help="Remove a cloud deployment from an existing cloud.",
+    help="Remove a cloud resource from an existing cloud.",
     cls=AnyscaleCommand,
-    example=command_examples.CLOUD_DEPLOYMENT_DELETE_EXAMPLE,
+    example=command_examples.CLOUD_RESOURCE_DELETE_EXAMPLE,
     is_alpha=True,
 )
 @click.option(
     "--cloud",
-    help="The name of the cloud to remove the deployment from.",
+    help="The name of the cloud to remove the resource from.",
     type=str,
     required=True,
 )
 @click.option(
-    "--deployment",
-    help="The name of the deployment to remove.",
+    "--resource",
+    help="The name of the cloud resource to remove.",
     type=str,
     required=True,
 )
 @click.option(
     "--yes", "-y", is_flag=True, default=False, help="Skip asking for confirmation."
 )
-def cloud_deployment_delete(cloud: str, deployment: str, yes: bool,) -> None:
+def cloud_resource_delete(cloud: str, resource: str, yes: bool,) -> None:
     try:
-        CloudController().remove_cloud_deployment(cloud, deployment, yes)
+        CloudController().remove_cloud_resource(cloud, resource, yes)
     except click.ClickException as e:
         print(e)
 
 
 @cloud_cli.command(
-    name="update",
-    help=(
-        "Update a managed cloud to the latest configuration. Only applicable for anyscale managed clouds."
-    ),
+    name="update", help=("Update a cloud."),
 )
 @click.argument("cloud-name", required=False)
 @click.option(
@@ -422,6 +358,18 @@ def cloud_deployment_delete(cloud: str, deployment: str, yes: bool,) -> None:
         "are manually granted permissions to access the cloud. No existing cloud permissions are altered by specifying this flag."
     ),
 )
+@click.option(
+    "--resources-file",
+    "-f",
+    help="EXPERIMENTAL: Path to a YAML file defining a list of cloud resources. Schema: https://docs.anyscale.com/reference/cloud/#cloudresource.",
+    required=False,
+)
+@click.option(
+    "--skip-verification",
+    is_flag=True,
+    default=False,
+    help="Skip cloud resource verification.",
+)
 def cloud_update(  # noqa: PLR0913
     cloud_name: Optional[str],
     name: Optional[str],
@@ -430,12 +378,23 @@ def cloud_update(  # noqa: PLR0913
     enable_head_node_fault_tolerance: bool,
     yes: bool,
     enable_auto_add_user: Optional[bool],
+    resources_file: Optional[str],
+    skip_verification: bool,
 ) -> None:
     if cloud_name and name and cloud_name != name:
         raise click.ClickException(
             "The positional argument CLOUD_NAME and the keyword argument --name "
             "were both provided. Please only provide one of these two arguments."
         )
+    if resources_file:
+        CloudController().update_cloud_resources(
+            cloud_name=cloud_name or name,
+            cloud_id=cloud_id,
+            resources_file=resources_file,
+            skip_verification=skip_verification,
+            yes=yes,
+        )
+        return
     if enable_head_node_fault_tolerance and (enable_auto_add_user is not None):
         raise click.ClickException(
             "Please only specify either --enable-head-node-fault-tolerance or "
@@ -740,7 +699,7 @@ def cloud_config_update(
 )
 @click.option(
     "--cloud-storage-bucket-name",
-    help="A fully qualified storage bucket name for cloud storage, e.g. s3://bucket-name, gs://bucket-name, or azure://bucket-name.",
+    help="A fully qualified storage bucket name for cloud storage, e.g. s3://bucket-name, gs://bucket-name, or abfss://bucket-name@account.dfs.core.windows.net.",
     required=False,
     type=str,
 )
@@ -769,6 +728,18 @@ def cloud_config_update(
     required=False,
     type=str,
 )
+@click.option(
+    "--persistent-volume-claim",
+    help="For Kubernetes deployments only, the name of the persistent volume claim used to mount shared storage into pods. Mutually exclusive with NFS configurations.",
+    required=False,
+    type=str,
+)
+@click.option(
+    "--csi-ephemeral-volume-driver",
+    help="For Kubernetes deployments only, the CSI ephemeral volume driver used to mount shared storage into pods. Mutually exclusive with NFS configurations.",
+    required=False,
+    type=str,
+)
 @click.option(
     "--memorystore-instance-name",
     help="Memorystore instance name for GCP clouds",
@@ -854,6 +825,8 @@ def register_cloud(  # noqa: PLR0913, PLR0912, C901
     cloud_storage_bucket_region: Optional[str],
     nfs_mount_target: List[str],
     nfs_mount_path: str,
+    persistent_volume_claim: Optional[str],
+    csi_ephemeral_volume_driver: Optional[str],
     memorystore_instance_name: str,
     host_project_id: Optional[str],
     kubernetes_zones: Optional[str],
@@ -865,6 +838,30 @@ def register_cloud(  # noqa: PLR0913, PLR0912, C901
     enable_auto_add_user: bool,
 ) -> None:
     missing_args: List[str] = []
+
+    # Validate K8S-only storage flags
+    if (
+        persistent_volume_claim or csi_ephemeral_volume_driver
+    ) and compute_stack != ComputeStack.K8S:
+        raise click.ClickException(
+            "--persistent-volume-claim and --csi-ephemeral-volume-driver are only supported with --compute-stack=k8s"
+        )
+
+    # Validate mutual exclusivity of storage configurations
+    storage_configs = []
+    if nfs_mount_target or nfs_mount_path:
+        storage_configs.append("NFS")
+    if persistent_volume_claim:
+        storage_configs.append("persistent volume claim")
+    if csi_ephemeral_volume_driver:
+        storage_configs.append("CSI ephemeral volume driver")
+
+    if len(storage_configs) > 1:
+        raise click.ClickException(
+            f"Storage configurations are mutually exclusive. Found: {', '.join(storage_configs)}. "
+            "Please specify only one of: --nfs-mount-target/--nfs-mount-path, --persistent-volume-claim, or --csi-ephemeral-volume-driver"
+        )
+
     if provider == "aws":
         if s3_bucket_id and not cloud_storage_bucket_name:
             cloud_storage_bucket_name = s3_bucket_id
@@ -927,6 +924,8 @@ def register_cloud(  # noqa: PLR0913, PLR0912, C901
             skip_verifications=skip_verifications,
             auto_add_user=enable_auto_add_user,
             external_id=external_id,
+            persistent_volume_claim=persistent_volume_claim,
+            csi_ephemeral_volume_driver=csi_ephemeral_volume_driver,
         )
     elif provider == "gcp":
         if filestore_instance_id and not file_storage_id:
@@ -1039,6 +1038,8 @@ def register_cloud(  # noqa: PLR0913, PLR0912, C901
             yes=yes,
             skip_verifications=skip_verifications,
             auto_add_user=enable_auto_add_user,
+            persistent_volume_claim=persistent_volume_claim,
+            csi_ephemeral_volume_driver=csi_ephemeral_volume_driver,
         )
     elif provider in ("azure", "generic"):
         # For the 'generic' provider type, for the time being, most fields are optional; only 'name', 'provider', and 'compute-stack' are required.
@@ -1060,6 +1061,8 @@ def register_cloud(  # noqa: PLR0913, PLR0912, C901
             cloud_storage_bucket_region=cloud_storage_bucket_region,
             nfs_mount_targets=list(nfs_mount_target) if nfs_mount_target else [],
             nfs_mount_path=nfs_mount_path,
+            persistent_volume_claim=persistent_volume_claim,
+            csi_ephemeral_volume_driver=csi_ephemeral_volume_driver,
             kubernetes_zones=kubernetes_zones.split(",") if kubernetes_zones else [],
             anyscale_operator_iam_identity=anyscale_operator_iam_identity,
         )
@@ -1334,14 +1337,16 @@ def get_cloud(
             log.error("Cloud not found.")
             return
 
-        # Include all cloud deployments for the cloud.
-        cloud_deployments = CloudController().get_cloud_deployments(cloud_id=cloud.id)
+        # Include all cloud resources for the cloud.
+        cloud_resources = CloudController().get_formatted_cloud_resources(
+            cloud_id=cloud.id
+        )
         result = {
             "name": cloud.name,
             "id": cloud.id,
             "created_at": cloud.created_at,
             "is_default": cloud.is_default,
-            "deployments": cloud_deployments.get("deployments", []),
+            "resources": cloud_resources,
         }
 
         if output:

anyscale/commands/command_examples.py

@@ -498,6 +498,7 @@ $ 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.
@@ -511,6 +512,32 @@ collaborators:
     permission_level: "owner"
 """
 
+
+PROJECT_GET_EXAMPLE = """\
+$ anyscale project get --id my-project-id
+"""
+
+
+PROJECT_LIST_EXAMPLE = """\
+$ anyscale project list --include-defaults --non-interactive --max-items 2
+"""
+
+
+PROJECT_CREATE_EXAMPLE = """\
+$ anyscale project create --name "my-project" --cloud "my-cloud-id"
+"""
+
+
+PROJECT_DELETE_EXAMPLE = """\
+$ anyscale project delete --id project-id
+"""
+
+
+PROJECT_GET_DEFAULT_EXAMPLE = """\
+$ anyscale project get-default --cloud my-cloud-id --json
+"""
+
+
 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.
@@ -522,34 +549,13 @@ collaborators:
     permission_level: "readonly"
 """
 
-CLOUD_DEPLOYMENT_CREATE_EXAMPLE = """\
-$ anyscale cloud deployment create --cloud my-cloud --file new-cloud-deployment.yaml
-Successfully created cloud deployment my-new-deployment in cloud my-cloud.
 
-$ cat new-cloud-deployment.yaml
-name: my-new-deployment
-provider: AWS
-compute_stack: VM
-region: us-west-2
-networking_mode: PUBLIC
-object_storage:
-  bucket_name: s3://my-bucket
-file_storage:
-  file_storage_id: fs-123
-aws_config:
-  vpc_id: vpc-123
-  subnet_ids:
-  - subnet-123
-  security_group_ids:
-  - sg-123
-  anyscale_iam_role_id: arn:aws:iam::123456789012:role/anyscale-role-123
-  cluster_iam_role_id: arn:aws:iam::123456789012:role/cluster-role-123
-  memorydb_cluster_name: my-memorydb-cluster
-"""
+CLOUD_RESOURCE_CREATE_EXAMPLE = """\
+$ anyscale cloud resource create --cloud my-cloud --file new-cloud-resource.yaml
+Successfully created cloud resource my-new-resource in cloud my-cloud.
 
-CLOUD_DEPLOYMENT_GET_EXAMPLE = """\
-$ anyscale cloud deployment get --cloud my-cloud --deployment my-deployment
-name: my-deployment
+$ cat new-cloud-resource.yaml
+name: my-new-resource
 provider: AWS
 compute_stack: VM
 region: us-west-2
@@ -569,29 +575,11 @@ aws_config:
   memorydb_cluster_name: my-memorydb-cluster
 """
 
-
-CLOUD_DEPLOYMENT_UPDATE_EXAMPLE = """\
-$ anyscale cloud deployment update --cloud my-cloud --file updated-cloud-deployment.yaml
-Output
-(anyscale +3.7s) Detected the following changes:
---- +++ @@ -15,9 +15,9 @@   file_storage_id: fs-123
--name: my-cloud-deployment
-+name: my-updated-cloud-deployment
- networking_mode: PUBLIC
- object_storage:
--  bucket_name: s3://my-bucket
-+  bucket_name: s3://my-updated-bucket
- provider: AWS
-Would you like to proceed with updating this cloud deployment? [y/N]: y
-(anyscale +10.2s) Successfully updated cloud deployment my-updated-cloud-deployment in cloud my-cloud.
-"""
-
-
-CLOUD_DEPLOYMENT_DELETE_EXAMPLE = """\
-$ anyscale cloud deployment delete --cloud my-cloud --deployment my-deployment
+CLOUD_RESOURCE_DELETE_EXAMPLE = """\
+$ anyscale cloud resource delete --cloud my-cloud --resource my-resource
 Output
-Please confirm that you would like to remove deployment my-deployment from cloud my-cloud. [y/N]: y
-(anyscale +3.5s) Successfully removed deployment my-deployment from cloud my-cloud!
+Please confirm that you would like to remove resource my-resource from cloud my-cloud. [y/N]: y
+(anyscale +3.5s) Successfully removed resource my-resource from cloud my-cloud!
 """
 
 CLOUD_GET_CLOUD_EXAMPLE = """\
@@ -601,7 +589,7 @@ name: my-cloud
 created_at: 2022-10-18 05:12:13.335803+00:00
 is_default: true
 deployments:
-- cloud_deployment_id: cldrsrc_123
+- cloud_resource_id: cldrsrc_123
   name: vm-aws-us-west-2
   provider: AWS
   compute_stack: VM

anyscale/commands/exec_commands.py

@@ -1,14 +1,25 @@
 import click
 
+from anyscale.commands.util import DeprecatedAnyscaleCommand
+
 
 @click.command(
     name="exec",
     hidden=True,
     help="[DEPRECATED] Execute shell commands in interactive cluster.",
     context_settings={"ignore_unknown_options": True, "allow_extra_args": True,},
+    cls=DeprecatedAnyscaleCommand,
+    removal_date="2025-10-01",
+    deprecation_message="`anyscale exec` has been deprecated and no longer works on Anyscale",
+    alternative="use `anyscale job submit` to run your script as a job in a cluster",
 )
 def anyscale_exec() -> None:
+    """Execute shell commands in interactive cluster.
+
+    DEPRECATED: This command will be removed on 2025-10-01.
+    Use 'anyscale job submit' to run your script as a job in a cluster.
+    """
     raise click.ClickException(
-        "Warning: `anyscale exec` has been deprecated and no longer works on Anyscale V2. "
+        "`anyscale exec` has been deprecated and no longer works on Anyscale. "
         "Please use `anyscale job submit` to run your script as a job in a cluster."
     )