update-auto-scale-rules¶

Description¶

Modify AutoScaling for a DataHub cluster

Synopsis¶

  update-auto-scale-rules
--cluster-name <value>
[--enabled | --no-enabled]
[--auto-scale-policies <value>]
[--use-stop-start-mechanism | --no-use-stop-start-mechanism]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-name (string)

The name or CRN of the cluster.

--enabled | --no-enabled (boolean)

true to enable Autoscaling, false to disable AutoScaling. If not specified, the existing value is used.

--auto-scale-policies (array)

The actual scaling policies for the cluster

JSON Syntax:

[
  {
    "hostGroups": "string",
    "scheduleBasedPolicy": {
      "schedules": [
        {
          "configuration": {
            "trigger": {
              "cronExpression": "string",
              "timeZone": "string"
            },
            "action": {
              "resourceAdjustmentType": "ABSOLUTE_COUNT",
              "resourceAdjustmentValue": integer
            }
          },
          "identifier": "string",
          "description": "string"
        }
        ...
      ]
    },
    "loadBasedPolicy": {
      "configuration": {
        "minResourceValue": integer,
        "maxResourceValue": integer,
        "coolDownMinutes": integer,
        "scaleUpCoolDownMinutes": integer,
        "scaleDownCoolDownMinutes": integer,
        "maxScaleUpStepSize": integer,
        "maxScaleDownStepSize": integer
      },
      "identifier": "string",
      "description": "string"
    }
  }
  ...
]

--use-stop-start-mechanism | --no-use-stop-start-mechanism (boolean)

true to enable StopStart scaling mechanism, false to use regular AutoScaling (if enabled). If not specified, the existing value is used.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

autoScaleRules -> (object)

Autoscale configuration

clusterName -> (string)

The name or CRN of the cluster.

enabled -> (boolean)

Whether autoscaling is enabled or not for the cluster

autoScalePolicies -> (array)

The actual scaling policy(ies) for the cluster

item -> (object)

An individual AutoScale Policy

hostGroups -> (string)

A single hostgroup, or a comma separated list of hostGroups to which the rules apply

scheduleBasedPolicy -> (object)

Schedule for AutoScaling

schedules -> (array)

List of individual schedules

item -> (object)

An individual schedule based policy

configuration -> (object)

The schedule configuration.

trigger -> (object)

The trigger for this rule.

cronExpression -> (string)

The cron expression for this schedule

timeZone -> (string)

The time zone for the cron expression

action -> (object)

The scaling action to take when triggered.

resourceAdjustmentType -> (string)

The type of resource adjustment. Only ABSOLUTE_COUNT supported at the moment.

resourceAdjustmentValue -> (integer)

The target value for the resource based on the AdjustmentType

identifier -> (string)

An identifier fot the specific schedule. Generally usefulf for debugging.

description -> (string)

Description for the specified schedule.

loadBasedPolicy -> (object)

Configuration for Load Based Scaling

configuration -> (object)

Configuration for load based scaling

minResourceValue -> (integer)

The lower bound for the resource

maxResourceValue -> (integer)

The upper bound for the resource

coolDownMinutes -> (integer)

Minimum time, in minutes, between autoscale activity

scaleUpCoolDownMinutes -> (integer)

Minimum time (in minutes) for scale up, after last autoscaling action. Use this to override coolDownMinutes.

scaleDownCoolDownMinutes -> (integer)

Minimum time (in minutes) for scale down, after last autoscaling action. Use this to override coolDownMinutes.

maxScaleUpStepSize -> (integer)

The maximum scale up step size.

maxScaleDownStepSize -> (integer)

The maximum scale down step size.

identifier -> (string)

An identifer for this rule. Useful for debugging and logging.

description -> (string)

Description for the specified schedule.

useStopStartMechanism -> (boolean)

Whether StopStart scaling mechanism is enabled for the cluster.

Form Factors¶

public