opentelekomcloud.cloud.as_policy module – Create/Remove Auto Scaling Policy from the OTC

Note

This module is part of the opentelekomcloud.cloud collection (version 0.11.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 opentelekomcloud.cloud.

To use it in a playbook, specify: opentelekomcloud.cloud.as_policy.

New in version 0.8.0: of opentelekomcloud.cloud

Synopsis

  • Create/Remove Auto Scaling Policy from the OTC.

Requirements

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

  • openstacksdk

  • openstacksdk >= 0.36.0

  • otcextensions

  • python >= 3.6

Parameters

Parameter

Comments

alarm

string

Specifies the periodic or scheduled AS policy.

This parameter is mandatory when scaling_policy_type is set to ALARM.

api_timeout

integer

How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.

auth

dictionary

Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.

auth_type

string

Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.

ca_cert

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

cloud

raw

Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.

cool_down_time

integer

Specifies the cooldown period (in seconds).

The value ranges from 0 to 86400

Default: 300

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • admin

  • internal

  • public ← (default)

region_name

string

Name of the region.

scaling_group

string

Name or ID of the AS group.

scaling_policy

string / required

Specifies the AS policy name or ID.

Max name length is 64 characters.

Name can contains only letters, digits, underscores, hyphens

scaling_policy_action

dictionary

Specifies the scaling action of the AS policy.

instance_number

integer

Specifies the number of instances to be operated.

The default number is 1.

Either instance_number or instance_percentage is required.

If operation is set to SET, the value range is 0 to 200.

If operation is set to ADD, REMOVE or REDUCE, the value range is 1 to 200.

Default: 1

instance_percentage

integer

Specifies the percentage of instances to be operated.

If operation is set to ADD, REMOVE or REDUCE, the value of this parameter is an integer from 1 to 20000.

If operation is set to SET, the value is an integer from 0 to 20000.

Either instance_number or instance_percentage is required.

If neither instance_number nor instance_percentage is specified, the number of instances to be operated is 1.

operation

string

Specifies the operation to be performed.

The default operation is ADD.

Choices:

  • add ← (default)

  • remove

  • reduce

  • set

scaling_policy_type

string

Specifies the AS policy type

Choices:

  • alarm

  • scheduled

  • recurrence

scheduled_policy

dictionary

Specifies the periodic or scheduled AS policy.

This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE.

end_time

string

Specifies the end time of the scaling action triggered periodically.

The end time cannot be earlier than the current and start time.

The time format complies with UTC.

The time format is YYYY-MM-DDThh:mmZ.

launch_time

string

Specifies the time when the scaling action is triggered.

The time format complies with UTC.

If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.

If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.

recurrence_type

string

Specifies the periodic triggering type.

This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

Choices:

  • daily

  • weekly

  • monthly

recurrence_value

string

Specifies the day when a periodic scaling action is triggered.

This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

If recurrence_type is set to “Daily”, the value is null, indicating that the scaling action is triggered once a day.

If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.

If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.

start_time

string

Specifies the start time of the scaling action triggered periodically.

The time format complies with UTC.

The default value is the local time.

The time format is YYYY-MM-DDThh:mmZ.

state

string

Whether resource should be present or absent.

Choices:

  • present ← (default)

  • absent

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • no ← (default)

  • yes

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

  • Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# Create AS Policy
- opentelekomcloud.cloud.as_policy:
    scaling_group: "as-group-test"
    scaling_policy: "collection-test"
    scaling_policy_type: "alarm"
    alarm: "as-alarm-test"
  register: result

# Update AS Policy
- opentelekomcloud.cloud.as_policy:
    scaling_group: "as-group-test"
    scaling_policy: "collection-test"
    scaling_policy_type: "alarm"
    alarm: "as-alarm-test"
    scaling_policy_action:
      operation: "add"
      instance_number: 1
  register: as_policy

# Delete AS Policy
- opentelekomcloud.cloud.as_policy:
    scaling_group: "{{ as_group_name}}"
    scaling_policy: "{{ as_policy_name }}"
    state: "absent"
  register: as_policy

Return Values

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

Key

Description

as_policy

complex

AS policy ID.

Returned: success

scaling_policy_id

string

Specifies the AS policy ID.

Returned: success

Sample: “0h327883-324n-4dzd-9c61-68d03ee191dd”

Authors

  • Irina Pereiaslavskaia (@irina-pereiaslavskaia)

Whats next

last updated: 2022-02-25 12:26