ALTER CLUSTER

Alter the settings of an existing cluster

Overview

The ALTER CLUSTER command is used to modify the configuration of an existing cluster in Upsolver.

Syntax

ALTER CLUSTER <cluster_name> SET 
  [MIN_INSTANCES = <min_instance_count>]
  [MAX_INSTANCES = <max_instance_count>]
  [COMMENT = '<comment>']
  [STATIC_PUBLIC_IPS = <number_of_static_ips>]
  [ON_DEMAND_INSTANCES = <on_demand_instance_count>]
  [MAX_REPLAY_INSTANCES = <max_replay_instance_count>]
  [INSTANCE_TYPE_FAMILY = '<instance_type_family>']
  [SCALING_STRATEGY = {LOW_COST | LOW_LATENCY | CONSISTENT_LOW_LATENCY | NO_SCALING }]
  [ALLOW_MAINTENANCE_ACCESS = {TRUE | FALSE}]

Options:

1. MIN_INSTANCES = <min_instance_count>:

   • This sets the minimum number of instances the cluster should maintain.

   • Example: ALTER CLUSTER myCluster SET MIN_INSTANCES = 1

2. MAX_INSTANCES = <max_instance_count>:

   • This sets the maximum number of instances the cluster can scale up to.

   • Example: ALTER CLUSTER myCluster SET MAX_INSTANCES = 4

3. COMMENT = '<comment>':

   • Adds a comment or description to the cluster for documentation or clarification purposes.

   • Example: ALTER CLUSTER myCluster SET COMMENT = 'This is my test cluster'

4. STATIC_PUBLIC_IPS = <number_of_static_ips>:

   • Specifies the number of static public IPs that should be allocated to the cluster.

   • Increasing this number will allocate new Elastic IPs to the cluster.

   • Example: ALTER CLUSTER myCluster SET STATIC_PUBLIC_IPS = 1

5. ON_DEMAND_INSTANCES = <on_demand_instance_count>:

   • Specifies the minimum number of guaranteed on-demand instances allocated to the cluster.

   • While this sets a floor, there may sometimes be more on-demand instances if there's low spot availability.

   • Example: ALTER CLUSTER myCluster SET ON_DEMAND_INSTANCES = 1

6. MAX_REPLAY_INSTANCES = <max_replay_instance_count>:

   • Sets the maximum number of instances used for replay tasks.

   • Replay instances are separate from normal processing instances and will turn off when there's no replay activity occurring.

   • Example: ALTER CLUSTER myCluster SET MAX_REPLAY_INSTANCES = 8

7. INSTANCE_TYPE_FAMILY = '<instance_type_family>':

   • Specifies the exact instance type for the cluster.

   • Examples of instance types: m5.2xlarge, r5.xlarge, r5.2xlarge.

   • Example: ALTER CLUSTER myCluster SET INSTANCE_TYPE_FAMILY = 'm5.2xlarge'

8. SCALING_STRATEGY:

   • Determines the scaling strategy of the cluster. Options are:

     • LOW_COST: Prioritize cost savings.

     • LOW_LATENCY: Prioritize reducing latency.

     • CONSISTENT_LOW_LATENCY: Maintain consistently low latency.

     • NO_SCALING: No scaling, static number of instances.

   • Example: ALTER CLUSTER myCluster SET SCALING_STRATEGY = LOW_COST

9. ALLOW_MAINTENANCE_ACCESS = {TRUE | FALSE}:

   • Determines if maintenance access is allowed. If set to TRUE, it permits Upsolver support to SSH into the instances for troubleshooting purposes.

   • Example: ALTER CLUSTER myCluster SET ALLOW_MAINTENANCE_ACCESS = TRUE