Skip to main content

ALTER CLUSTER

Description​

Modify an existing Cluster.

Usage Tip: Only include the parameters you want to change. You must include at least 1 of the optional parameters.

Note that the SQL statement does not end with ;

Syntax​

ALTER CLUSTER <cluster_name>
  [ SET STATE = { 'STOP' | 'START' } ]
  [ MAX_OCU = <int> ]
  [ MIN_OCU = <int> ]
  [ NEW_NAME = <string> ]
  WITH 'key1' = 'value1', 'key2' = 'value2' ....

Sample response

Examples​

Update max OCU, min OCU, and Cluster name:

ALTER CLUSTER managed_cluster_retail
  MAX_OCU = 30
  MIN_OCU = 5
  NEW_NAME = 'bigger_managed_cluster_retail'

Stop a running Cluster:

ALTER CLUSTER managed_cluster_retail
  SET STATE = 'STOP'

Update compute limits for Ray Open Engines Cluster:

ALTER CLUSTER ray_cluster
  MAX_OCU = 8
  MIN_OCU = 2
  WITH 'open_engines.ray.max_cpu_units' = '5', 'open_engines.ray.min_cpu_units' = '2', 'open_engines.ray.max_gpu_units' = '3'

Required parameters​

  • <cluster_name>: Specify the name of the Cluster to modify.

Optional parameters​

  • STATE: Start or stop the Cluster.
  • MAX_OCU: Update the maximum OCU for the Cluster.
  • MIN_OCU: Update the minimum OCU for the Cluster.
  • NEW_NAME: Change the name of the Cluster.

Special parameters​

Include special parameters and advanced configs after WITH as type String.

Instance type parameters​

  • worker.type: Specify the worker instance type as a String. Must be a standard Onehouse instance type (eg. 'oh-general-4') or a custom instance type that's been enabled for the project (eg. 'm8g.xlarge'). View more on instance types.
  • worker.spot: Specify 'TRUE' or 'FALSE' to enable/disable spot instances for workers.
  • driver.type: Specify the driver instance type as a String. Default is 'Auto', which uses the same instance type as workers.

Open Engines parameters​

  • open_engines.ray.max_cpu_units: Specify the maximum CPU units the Cluster can scale to. The max CPU Units and max GPU units must sum to the Max OCU you set above.
  • open_engines.ray.min_cpu_units: Specify the minimum CPU units the Cluster will always run. This must be the same value you set for the Min OCU above.
  • open_engines.ray.max_gpu_units: Specify the maximum GPU units the Cluster can scale to. The max CPU Units and max GPU units must sum to the Max OCU you set above.

Things to consider​

  • Running a new Job is disabled while the compute cluster is being modified.
  • Reducing the max OCU of a cluster may disrupt any Job running in the cluster.