Skip to main content
Version: Latest

Cloud API Reference

Check your docs version

These docs are for the new Anyscale design. If you started using Anyscale before April 2024, use Version 1.0.0 of the docs. If you're transitioning to Anyscale Preview, see the guide for how to migrate.

Customer-hosted cloud features​

note

Some features are only available on customer-hosted clouds. Reach out to preview-help@anyscale.com for info.

Cloud Models​

Cloud CLI​

anyscale cloud setup​

Usage

anyscale cloud setup [OPTIONS]

Set up a cloud provider.

Options

  • --provider: The cloud provider type.
  • --region: Region to set up the credentials in.
  • --name/-n: Name of the cloud.
  • --functional-verify: Verify the cloud is functional. This will check that the cloud can launch workspace/service.
  • --anyscale-managed: Let anyscale create all the resources.
  • --enable-head-node-fault-tolerance: Whether to enable head node fault tolerance for services.
  • --yes/-y: Skip asking for confirmation.
  • --disable-auto-add-user: All users in the organization will be added to clouds created with anyscale cloud setup by default. Specify --disable-auto-add-user to disable this and instead manually grant users permissions to the cloud.

anyscale cloud register​

Usage

anyscale cloud register [OPTIONS]

Register an anyscale cloud with your own resources.

Options

  • --provider: The cloud provider type.
  • --region: Region to set up the credentials in.
  • --name/-n: Name of the cloud.
  • --vpc-id: The ID of the VPC.
  • --subnet-ids: Comma separated list of subnet ids.
  • --efs-id: The EFS ID.
  • --anyscale-iam-role-id: The Anyscale IAM Role ARN.
  • --instance-iam-role-id: The instance IAM role ARN.
  • --security-group-ids: IDs of the security groups.
  • --s3-bucket-id: S3 bucket ID.
  • --external-id: The trust policy external ID for the cross account IAM role.
  • --memorydb-cluster-id: Memorydb cluster ID
  • --vpc-name: VPC name for GCP clouds
  • --subnet-names: Comma separated list of subnet names for GCP clouds
  • --filestore-instance-id: Filestore instance ID for GCP clouds.
  • --filestore-location: Filestore location for GCP clouds.
  • --anyscale-service-account-email: Anyscale service account email for GCP clouds.
  • --instance-service-account-email: Instance service account email for GCP clouds.
  • --provider-name: Workload Identity Federation provider name for Anyscale access.
  • --firewall-policy-names: Filewall policy names for GCP clouds
  • --cloud-storage-bucket-name: Cloud storage bucket name for GCP clouds
  • --memorystore-instance-name: Memorystore instance name for GCP clouds
  • --host-project-id: Host project ID for shared VPC
  • --private-network: Use private network.
  • --functional-verify: Verify the cloud is functional. This will check that the cloud can launch workspace/service.
  • --yes/-y: Skip asking for confirmation.
  • --skip-verifications: Skip verifications. This will skip all verifications.
  • --enable-auto-add-user: If --enable-auto-add-user is specified for a cloud, all users in the organization will be added to the cloud by default. Otherwise users will need to be manually granted permissions to the cloud. Note: There may be up to 30 sec delay for all users to be granted permissions after the cloud is created.

anyscale cloud edit​

Usage

anyscale cloud edit [OPTIONS] [CLOUD_NAME]

Edit registered cloud resource on Anyscale. Only applicable for anyscale registered clouds.

Options

  • --name/-n: Edit cloud by name.
  • --cloud-id/--id: Edit cloud by id, alternative to cloud name.
  • --aws-s3-id: New S3 bucket ID.
  • --aws-efs-id: New EFS ID.
  • --aws-efs-mount-target-ip: New EFS mount target IP.
  • --memorydb-cluster-id: New AWS Memorydb cluster ID.
  • --gcp-filestore-instance-id: New GCP filestore instance id.
  • --gcp-filestore-location: New GCP filestore location.
  • --gcp-cloud-storage-bucket-name: New GCP Cloud storage bucket name.
  • --memorystore-instance-name: New Memorystore instance name for GCP clouds
  • --functional-verify: Verify the cloud is functional. This will check that the cloud can launch workspace/service.
  • --enable-auto-add-user/--disable-auto-add-user: If --enable-auto-add-user is specified for a cloud, all users in the organization will be added to the cloud by default. Note: There may be up to 30 sec delay for all users to be granted permissions after this feature is enabled.

Specifying --disable-auto-add-user will require that users are manually granted permissions to access the cloud. No existing cloud permissions are altered by specifying this flag.

anyscale cloud update​

Usage

anyscale cloud update [OPTIONS] [CLOUD_NAME]

Update a managed cloud to the latest configuration. Only applicable for anyscale managed clouds.

Options

  • --cloud-id/--id: Cloud id to update. Alternative to cloud name.
  • --name/-n: Update configuration of cloud by name.
  • --yes/-y: Skip asking for confirmation.
  • --functional-verify: Verify the cloud is functional. This will check that the cloud can launch workspace/service.
  • --enable-head-node-fault-tolerance: Whether to enable head node fault tolerance for services.
  • --enable-auto-add-user/--disable-auto-add-user: If --enable-auto-add-user is specified for a cloud, all users in the organization will be added to the cloud by default. Note: There may be up to 30 sec delay for all users to be granted permissions after this feature is enabled.

Specifying --disable-auto-add-user will require that users are manually granted permissions to access the cloud. No existing cloud permissions are altered by specifying this flag.

anyscale cloud delete​

Usage

anyscale cloud delete [OPTIONS] [CLOUD_NAME]

Delete a cloud.

Options

  • --name/-n: Delete cloud by name.
  • --cloud-id/--id: Cloud id to delete. Alternative to cloud name.
  • --yes/-y: Don't ask for confirmation.

anyscale cloud verify​

Usage

anyscale cloud verify [OPTIONS] [CLOUD_NAME]

Checks the healthiness of a cloud.

Options

  • --name/-n: Verify cloud by name.
  • --cloud-id/--id: Verify cloud by cloud id, alternative to cloud name.
  • --functional-verify: Verify the cloud is functional. This will check that the cloud can launch workspace/service.
  • --strict: Strict Verify. Treat warnings as failures.

anyscale cloud list​

Usage

anyscale cloud list [OPTIONS]

List information about clouds in your Anyscale organization.

Options

  • --name/-n: Name of cloud to get information about.
  • --cloud-id/--id: Id of cloud to get information about.
  • --max-items: Max items to show in list.

anyscale cloud config update​

Usage

anyscale cloud config update [OPTIONS] [CLOUD_NAME]

Update the current configuration for a cloud.

Options

  • --name/-n: Update configuration of cloud by name.
  • --cloud-id/--id: Cloud id to get details about. Alternative to cloud name.
  • --enable-log-ingestion/--disable-log-ingestion: If --enable-log-ingestion is specified for a cloud, it will enable the log viewing and querying UI features for the clusters on this cloud. This will enable easier debugging. The logs produced by the clusters will be sent from the data plane to the control plane. Anyscale does not share this data with any third party or use it for any purpose other than serving the log UI for the customer. The log will be stored at most 30 days.Please note by disable this feature again, Anyscale doesn't delete the logs that have already been ingested. Your clusters may incur extra data transfer cost from the cloud provider by enabling this feature.