oracle.oci.oci_bds_auto_scale_config – Manage a BdsAutoScaleConfig resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_bds_auto_scale_config.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a BdsAutoScaleConfig resource in Oracle Cloud Infrastructure

  • For state=present, add an autoscale configuration to the cluster.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
auto_scaling_configuration_id
string
Unique Oracle-assigned identifier of the autoscale configuration.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
bds_instance_id
string / required
The OCID of the cluster.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
cluster_admin_password
string
Base-64 encoded password for the cluster (and Cloudera Manager) admin user.
Required for create using state=present.
Required for delete using state=absent.
This parameter is updatable.
compartment_id
string
The OCID of the compartment.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
display_name
string
A user-friendly name. The name does not have to be unique, and it may be changed. Avoid entering confidential information.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
is_enabled
boolean
    Choices:
  • no
  • yes
Whether the autoscale configuration is enabled.
Required for create using state=present.
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
node_type
string
A node type that is managed by an autoscale configuration. The only supported types are WORKER and COMPUTE_ONLY_WORKER.
Required for create using state=present.
policy
dictionary
This parameter is updatable.
policy_type
string / required
    Choices:
  • THRESHOLD_BASED
  • SCHEDULE_BASED
  • NONE
Types of autoscale policies. Options are SCHEDULE-BASED or THRESHOLD-BASED. (Only THRESHOLD-BASED is supported in this release.)
rules
list / elements=dictionary / required
The list of rules for autoscaling. If an action has multiple rules, the last rule in the array will be applied.
action
string / required
    Choices:
  • CHANGE_SHAPE_SCALE_UP
  • CHANGE_SHAPE_SCALE_DOWN
The valid value are CHANGE_SHAPE_SCALE_UP or CHANGE_SHAPE_SCALE_DOWN.
metric
dictionary / required
metric_type
string / required
    Choices:
  • CPU_UTILIZATION
Allowed value is CPU_UTILIZATION.
threshold
dictionary / required
duration_in_minutes
integer / required
This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.
operator
string / required
    Choices:
  • GT
  • LT
The comparison operator to use. Options are greater than (GT) or less than (LT).
value
integer / required
Integer non-negative value. 0 < value < 100
policy_details
dictionary
This parameter is updatable.
policy_type
string / required
    Choices:
  • METRIC_BASED_HORIZONTAL_SCALING_POLICY
  • SCHEDULE_BASED_VERTICAL_SCALING_POLICY
  • SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY
  • METRIC_BASED_VERTICAL_SCALING_POLICY
Type of autoscaling policy.
This parameter is updatable.
scale_down_config
dictionary
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
memory_step_size
integer
For nodes with flexible compute shapes, this value is the size of memory in GBs to remove from each node during a scale-down event. This value is not used for nodes with fixed compute shapes.
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
metric
dictionary
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
metric_type
string / required
    Choices:
  • CPU_UTILIZATION
Allowed value is CPU_UTILIZATION.
Required when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
threshold
dictionary / required
Required when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
duration_in_minutes
integer / required
This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.
Required when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
operator
string / required
    Choices:
  • GT
  • LT
The comparison operator to use. Options are greater than (GT) or less than (LT).
Required when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
value
integer / required
Integer non-negative value. 0 < value < 100
Required when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
min_memory_per_node
integer
For nodes with flexible compute shapes, this value is the minimum memory in GBs each node can be scaled-down to. This value is not used for nodes with fixed compute shapes.
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
min_ocpus_per_node
integer
For nodes with flexible compute shapes, this value is the minimum number of OCPUs each node can be scaled-down to. This value is not used for nodes with fixed compute shapes.
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
ocpu_step_size
integer
For nodes with flexible compute shapes, this value is the number of OCPUs to remove from each node during a scale-down event. This value is not used for nodes with fixed compute shapes.
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
scale_in_config
dictionary
Applicable when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
metric
dictionary
Applicable when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
metric_type
string / required
    Choices:
  • CPU_UTILIZATION
Allowed value is CPU_UTILIZATION.
Required when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
threshold
dictionary / required
Required when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
duration_in_minutes
integer / required
This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.
Required when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
operator
string / required
    Choices:
  • GT
  • LT
The comparison operator to use. Options are greater than (GT) or less than (LT).
Required when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
value
integer / required
Integer non-negative value. 0 < value < 100
Required when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
min_node_count
integer
This value is the minimum number of nodes the cluster can be scaled-in to.
Applicable when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
step_size
integer
This value is the number of nodes to remove during a scale-in event.
Applicable when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
scale_out_config
dictionary
Applicable when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
max_node_count
integer
This value is the maximum number of nodes the cluster can be scaled-out to.
Applicable when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
metric
dictionary
Applicable when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
metric_type
string / required
    Choices:
  • CPU_UTILIZATION
Allowed value is CPU_UTILIZATION.
Required when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
threshold
dictionary / required
Required when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
duration_in_minutes
integer / required
This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.
Required when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
operator
string / required
    Choices:
  • GT
  • LT
The comparison operator to use. Options are greater than (GT) or less than (LT).
Required when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
value
integer / required
Integer non-negative value. 0 < value < 100
Required when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
step_size
integer
This value is the number of nodes to add during a scale-out event.
Applicable when policy_type is 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'
scale_up_config
dictionary
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
max_memory_per_node
integer
For nodes with flexible compute shapes, this value is the maximum memory in GBs each node can be scaled-up to. This value is not used for nodes with fixed compute shapes.
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
max_ocpus_per_node
integer
For nodes with flexible compute shapes, this value is the maximum number of OCPUs each node can be scaled-up to. This value is not used for nodes with fixed compute shapes.
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
memory_step_size
integer
For nodes with flexible compute shapes, this value is the size of memory in GBs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
metric
dictionary
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
metric_type
string / required
    Choices:
  • CPU_UTILIZATION
Allowed value is CPU_UTILIZATION.
Required when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
threshold
dictionary / required
Required when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
duration_in_minutes
integer / required
This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.
Required when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
operator
string / required
    Choices:
  • GT
  • LT
The comparison operator to use. Options are greater than (GT) or less than (LT).
Required when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
value
integer / required
Integer non-negative value. 0 < value < 100
Required when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
ocpu_step_size
integer
For nodes with flexible compute shapes, this value is the number of OCPUs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.
Applicable when policy_type is 'METRIC_BASED_VERTICAL_SCALING_POLICY'
schedule_details
list / elements=dictionary
Applicable when policy_type is one of ['SCHEDULE_BASED_VERTICAL_SCALING_POLICY', 'SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY']
schedule_type
string / required
    Choices:
  • DAY_BASED
The type of schedule.
This parameter is updatable.
time_and_horizontal_scaling_config
list / elements=dictionary
target_node_count
integer
This value is the desired number of nodes in the cluster.
time_recurrence
string
Day/time recurrence (specified following RFC 5545) at which to trigger autoscaling action. Currently only WEEKLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR and BYMINUTE fields. Other fields are not supported.
time_and_vertical_scaling_config
list / elements=dictionary
target_memory_per_node
integer
For nodes with flexible compute shapes, this value is the desired memory in GBs on each node. This value is not used for nodes with fixed compute shapes.
target_ocpus_per_node
integer
For nodes with flexible compute shapes, this value is the desired OCPUs count on each node. This value is not used for nodes with fixed compute shapes.
target_shape
string
For nodes with fixed compute shapes, this value is the desired shape of each node. This value is not used for nodes with flexible compute shapes.
time_recurrence
string
Day/time recurrence (specified following RFC 5545) at which to trigger autoscaling action. Currently only WEEKLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR and BYMINUTE fields. Other fields are not supported.
timezone
string
The time zone of the execution schedule, in IANA time zone database name format
This parameter is updatable.
Applicable when policy_type is one of ['SCHEDULE_BASED_VERTICAL_SCALING_POLICY', 'SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY']
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state
string
    Choices:
  • present ←
  • absent
The state of the BdsAutoScaleConfig.
Use state=present to create or update a BdsAutoScaleConfig.
Use state=absent to delete a BdsAutoScaleConfig.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create bds_auto_scale_config
  oci_bds_auto_scale_config:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    node_type: node_type_example
    is_enabled: true
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password

    # optional
    display_name: display_name_example
    policy:
      # required
      policy_type: THRESHOLD_BASED
      rules:
      - # required
        action: CHANGE_SHAPE_SCALE_UP
        metric:
          # required
          metric_type: CPU_UTILIZATION
          threshold:
            # required
            duration_in_minutes: 56
            operator: GT
            value: 56
    policy_details:
      # required
      policy_type: METRIC_BASED_HORIZONTAL_SCALING_POLICY

      # optional
      scale_out_config:
        # optional
        metric:
          # required
          metric_type: CPU_UTILIZATION
          threshold:
            # required
            duration_in_minutes: 56
            operator: GT
            value: 56
        max_node_count: 56
        step_size: 56
      scale_in_config:
        # optional
        metric:
          # required
          metric_type: CPU_UTILIZATION
          threshold:
            # required
            duration_in_minutes: 56
            operator: GT
            value: 56
        min_node_count: 56
        step_size: 56

- name: Update bds_auto_scale_config
  oci_bds_auto_scale_config:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    auto_scaling_configuration_id: "ocid1.autoscalingconfiguration.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    is_enabled: true
    policy:
      # required
      policy_type: THRESHOLD_BASED
      rules:
      - # required
        action: CHANGE_SHAPE_SCALE_UP
        metric:
          # required
          metric_type: CPU_UTILIZATION
          threshold:
            # required
            duration_in_minutes: 56
            operator: GT
            value: 56
    policy_details:
      # required
      policy_type: METRIC_BASED_HORIZONTAL_SCALING_POLICY

      # optional
      scale_out_config:
        # optional
        metric:
          # required
          metric_type: CPU_UTILIZATION
          threshold:
            # required
            duration_in_minutes: 56
            operator: GT
            value: 56
        max_node_count: 56
        step_size: 56
      scale_in_config:
        # optional
        metric:
          # required
          metric_type: CPU_UTILIZATION
          threshold:
            # required
            duration_in_minutes: 56
            operator: GT
            value: 56
        min_node_count: 56
        step_size: 56
    cluster_admin_password: example-password

- name: Update bds_auto_scale_config using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_bds_auto_scale_config:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    is_enabled: true
    policy:
      # required
      policy_type: THRESHOLD_BASED
      rules:
      - # required
        action: CHANGE_SHAPE_SCALE_UP
        metric:
          # required
          metric_type: CPU_UTILIZATION
          threshold:
            # required
            duration_in_minutes: 56
            operator: GT
            value: 56
    policy_details:
      # required
      policy_type: METRIC_BASED_HORIZONTAL_SCALING_POLICY

      # optional
      scale_out_config:
        # optional
        metric:
          # required
          metric_type: CPU_UTILIZATION
          threshold:
            # required
            duration_in_minutes: 56
            operator: GT
            value: 56
        max_node_count: 56
        step_size: 56
      scale_in_config:
        # optional
        metric:
          # required
          metric_type: CPU_UTILIZATION
          threshold:
            # required
            duration_in_minutes: 56
            operator: GT
            value: 56
        min_node_count: 56
        step_size: 56
    cluster_admin_password: example-password

- name: Delete bds_auto_scale_config
  oci_bds_auto_scale_config:
    # required
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    auto_scaling_configuration_id: "ocid1.autoscalingconfiguration.oc1..xxxxxxEXAMPLExxxxxx"
    cluster_admin_password: example-password
    state: absent

- name: Delete bds_auto_scale_config using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_bds_auto_scale_config:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    bds_instance_id: "ocid1.bdsinstance.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
bds_auto_scale_config
complex
on success
Details of the BdsAutoScaleConfig resource acted upon by the current operation

Sample:
{'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'node_type': 'node_type_example', 'policy': {'policy_type': 'THRESHOLD_BASED', 'rules': [{'action': 'CHANGE_SHAPE_SCALE_UP', 'metric': {'metric_type': 'CPU_UTILIZATION', 'threshold': {'duration_in_minutes': 56, 'operator': 'GT', 'value': 56}}}]}, 'policy_details': {'action_type': 'VERTICAL_SCALING', 'policy_type': 'METRIC_BASED_VERTICAL_SCALING_POLICY', 'scale_down_config': {'memory_step_size': 56, 'metric': {'metric_type': 'CPU_UTILIZATION', 'threshold': {'duration_in_minutes': 56, 'operator': 'GT', 'value': 56}}, 'min_memory_per_node': 56, 'min_ocpus_per_node': 56, 'ocpu_step_size': 56}, 'scale_in_config': {'metric': {'metric_type': 'CPU_UTILIZATION', 'threshold': {'duration_in_minutes': 56, 'operator': 'GT', 'value': 56}}, 'min_node_count': 56, 'step_size': 56}, 'scale_out_config': {'max_node_count': 56, 'metric': {'metric_type': 'CPU_UTILIZATION', 'threshold': {'duration_in_minutes': 56, 'operator': 'GT', 'value': 56}}, 'step_size': 56}, 'scale_up_config': {'max_memory_per_node': 56, 'max_ocpus_per_node': 56, 'memory_step_size': 56, 'metric': {'metric_type': 'CPU_UTILIZATION', 'threshold': {'duration_in_minutes': 56, 'operator': 'GT', 'value': 56}}, 'ocpu_step_size': 56}, 'schedule_details': [{'schedule_type': 'DAY_BASED', 'time_and_horizontal_scaling_config': [{'target_node_count': 56, 'time_recurrence': 'time_recurrence_example'}], 'time_and_vertical_scaling_config': [{'target_memory_per_node': 56, 'target_ocpus_per_node': 56, 'target_shape': 'target_shape_example', 'time_recurrence': 'time_recurrence_example'}]}], 'timezone': 'timezone_example', 'trigger_type': 'METRIC_BASED'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
display_name
string
on success
A user-friendly name. The name does not have to be unique, and it may be changed. Avoid entering confidential information.

Sample:
display_name_example
 
id
string
on success
The unique identifier for the autoscale configuration.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The state of the autoscale configuration.

Sample:
CREATING
 
node_type
string
on success
A node type that is managed by an autoscale configuration. The only supported types are WORKER and COMPUTE_ONLY_WORKER.

Sample:
node_type_example
 
policy
complex
on success

   
policy_type
string
on success
Types of autoscale policies. Options are SCHEDULE-BASED or THRESHOLD-BASED. (Only THRESHOLD-BASED is supported in this release.)

Sample:
THRESHOLD_BASED
   
rules
complex
on success
The list of rules for autoscaling. If an action has multiple rules, the last rule in the array will be applied.

     
action
string
on success
The valid value are CHANGE_SHAPE_SCALE_UP or CHANGE_SHAPE_SCALE_DOWN.

Sample:
CHANGE_SHAPE_SCALE_UP
     
metric
complex
on success

       
metric_type
string
on success
Allowed value is CPU_UTILIZATION.

Sample:
CPU_UTILIZATION
       
threshold
complex
on success

         
duration_in_minutes
integer
on success
This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.

Sample:
56
         
operator
string
on success
The comparison operator to use. Options are greater than (GT) or less than (LT).

Sample:
GT
         
value
integer
on success
Integer non-negative value. 0 < value < 100

Sample:
56
 
policy_details
complex
on success

   
action_type
string
on success
The type of autoscaling action to take.

Sample:
VERTICAL_SCALING
   
policy_type
string
on success
Type of autoscaling policy.

Sample:
METRIC_BASED_VERTICAL_SCALING_POLICY
   
scale_down_config
complex
on success

     
memory_step_size
integer
on success
For nodes with flexible compute shapes, this value is the size of memory in GBs to remove from each node during a scale-down event. This value is not used for nodes with fixed compute shapes.

Sample:
56
     
metric
complex
on success

       
metric_type
string
on success
Allowed value is CPU_UTILIZATION.

Sample:
CPU_UTILIZATION
       
threshold
complex
on success

         
duration_in_minutes
integer
on success
This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.

Sample:
56
         
operator
string
on success
The comparison operator to use. Options are greater than (GT) or less than (LT).

Sample:
GT
         
value
integer
on success
Integer non-negative value. 0 < value < 100

Sample:
56
     
min_memory_per_node
integer
on success
For nodes with flexible compute shapes, this value is the minimum memory in GBs each node can be scaled-down to. This value is not used for nodes with fixed compute shapes.

Sample:
56
     
min_ocpus_per_node
integer
on success
For nodes with flexible compute shapes, this value is the minimum number of OCPUs each node can be scaled-down to. This value is not used for nodes with fixed compute shapes.

Sample:
56
     
ocpu_step_size
integer
on success
For nodes with flexible compute shapes, this value is the number of OCPUs to remove from each node during a scale-down event. This value is not used for nodes with fixed compute shapes.

Sample:
56
   
scale_in_config
complex
on success

     
metric
complex
on success

       
metric_type
string
on success
Allowed value is CPU_UTILIZATION.

Sample:
CPU_UTILIZATION
       
threshold
complex
on success

         
duration_in_minutes
integer
on success
This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.

Sample:
56
         
operator
string
on success
The comparison operator to use. Options are greater than (GT) or less than (LT).

Sample:
GT
         
value
integer
on success
Integer non-negative value. 0 < value < 100

Sample:
56
     
min_node_count
integer
on success
This value is the minimum number of nodes the cluster can be scaled-in to.

Sample:
56
     
step_size
integer
on success
This value is the number of nodes to remove during a scale-in event.

Sample:
56
   
scale_out_config
complex
on success

     
max_node_count
integer
on success
This value is the maximum number of nodes the cluster can be scaled-out to.

Sample:
56
     
metric
complex
on success

       
metric_type
string
on success
Allowed value is CPU_UTILIZATION.

Sample:
CPU_UTILIZATION
       
threshold
complex
on success

         
duration_in_minutes
integer
on success
This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.

Sample:
56
         
operator
string
on success
The comparison operator to use. Options are greater than (GT) or less than (LT).

Sample:
GT
         
value
integer
on success
Integer non-negative value. 0 < value < 100

Sample:
56
     
step_size
integer
on success
This value is the number of nodes to add during a scale-out event.

Sample:
56
   
scale_up_config
complex
on success

     
max_memory_per_node
integer
on success
For nodes with flexible compute shapes, this value is the maximum memory in GBs each node can be scaled-up to. This value is not used for nodes with fixed compute shapes.

Sample:
56
     
max_ocpus_per_node
integer
on success
For nodes with flexible compute shapes, this value is the maximum number of OCPUs each node can be scaled-up to. This value is not used for nodes with fixed compute shapes.

Sample:
56
     
memory_step_size
integer
on success
For nodes with flexible compute shapes, this value is the size of memory in GBs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.

Sample:
56
     
metric
complex
on success

       
metric_type
string
on success
Allowed value is CPU_UTILIZATION.

Sample:
CPU_UTILIZATION
       
threshold
complex
on success

         
duration_in_minutes
integer
on success
This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.

Sample:
56
         
operator
string
on success
The comparison operator to use. Options are greater than (GT) or less than (LT).

Sample:
GT
         
value
integer
on success
Integer non-negative value. 0 < value < 100

Sample:
56
     
ocpu_step_size
integer
on success
For nodes with flexible compute shapes, this value is the number of OCPUs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.

Sample:
56
   
schedule_details
complex
on success

     
schedule_type
string
on success
The type of schedule.

Sample:
DAY_BASED
     
time_and_horizontal_scaling_config
complex
on success

       
target_node_count
integer
on success
This value is the desired number of nodes in the cluster.

Sample:
56
       
time_recurrence
string
on success
Day/time recurrence (specified following RFC 5545) at which to trigger autoscaling action. Currently only WEEKLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR and BYMINUTE fields. Other fields are not supported.

Sample:
time_recurrence_example
     
time_and_vertical_scaling_config
complex
on success

       
target_memory_per_node
integer
on success
For nodes with flexible compute shapes, this value is the desired memory in GBs on each node. This value is not used for nodes with fixed compute shapes.

Sample:
56
       
target_ocpus_per_node
integer
on success
For nodes with flexible compute shapes, this value is the desired OCPUs count on each node. This value is not used for nodes with fixed compute shapes.

Sample:
56
       
target_shape
string
on success
For nodes with fixed compute shapes, this value is the desired shape of each node. This value is not used for nodes with flexible compute shapes.

Sample:
target_shape_example
       
time_recurrence
string
on success
Day/time recurrence (specified following RFC 5545) at which to trigger autoscaling action. Currently only WEEKLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR and BYMINUTE fields. Other fields are not supported.

Sample:
time_recurrence_example
   
timezone
string
on success
The time zone of the execution schedule, in IANA time zone database name format

Sample:
timezone_example
   
trigger_type
string
on success
The type of autoscaling trigger.

Sample:
METRIC_BASED
 
time_created
string
on success
The time the cluster was created, shown as an RFC 3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the autoscale configuration was updated, shown as an RFC 3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)