W3cubDocs

/Ansible

community.general.rax_scaling_group – Manipulate Rackspace Cloud Autoscale Groups

Note

This plugin is part of the community.general collection (version 3.8.1).

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 community.general.

To use it in a playbook, specify: community.general.rax_scaling_group.

Synopsis

  • Manipulate Rackspace Cloud Autoscale Groups

Requirements

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

  • pyrax
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
api_key
string
Rackspace API key, overrides credentials.

aliases: password
auth_endpoint
string
The URI of the authentication service.
If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/
config_drive
boolean
    Choices:
  • no ←
  • yes
Attach read-only configuration drive to server as label config-2
cooldown
integer
Default:
300
The period of time, in seconds, that must pass before any scaling can occur after the previous scaling. Must be an integer between 0 and 86400 (24 hrs).
credentials
path
File to find the Rackspace credentials in. Ignored if api_key and username are provided.

aliases: creds_file
disk_config
string
    Choices:
  • auto
  • manual
Disk partitioning strategy
If not specified, it will fallback to auto.
env
string
files
dictionary
Files to insert into the instance. Hash of remotepath: localpath
flavor
string / required
flavor to use for the instance
identity_type
string
Default:
"rackspace"
Authentication mechanism to use, such as rackspace or keystone.
image
string / required
image to use for the instance. Can be an id, human_id or name
key_name
string
key pair to use on the instance
loadbalancers
list / elements=dictionary
List of load balancer id and port hashes
max_entities
integer / required
The maximum number of entities that are allowed in the scaling group. Must be an integer between 0 and 1000.
meta
dictionary
A hash of metadata to associate with the instance
min_entities
integer / required
The minimum number of entities that are allowed in the scaling group. Must be an integer between 0 and 1000.
name
string / required
Name to give the scaling group
networks
list / elements=string
Default:
["public", "private"]
The network to attach to the instances. If specified, you must include ALL networks including the public and private interfaces. Can be id or label.
region
string
Region to create an instance in.
server_name
string / required
The base name for servers created by Autoscale
state
string
    Choices:
  • present ←
  • absent
Indicate desired state of the resource
tenant_id
string
The tenant ID used for authentication.
tenant_name
string
The tenant name used for authentication.
user_data
string
Data to be uploaded to the servers config drive. This option implies config_drive. Can be a file path or a string
username
string
Rackspace username, overrides credentials.
validate_certs
boolean
    Choices:
  • no
  • yes
Whether or not to require SSL validation of API endpoints.

aliases: verify_ssl
wait
boolean
    Choices:
  • no ←
  • yes
wait for the scaling group to finish provisioning the minimum amount of servers
wait_timeout
integer
Default:
300
how long before wait gives up, in seconds

Notes

Note

  • The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.
  • RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating
  • RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file
  • RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)
  • The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.
  • RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating
  • RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file
  • RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)

Examples

---
- hosts: localhost
  gather_facts: false
  connection: local
  tasks:
    - community.general.rax_scaling_group:
        credentials: ~/.raxpub
        region: ORD
        cooldown: 300
        flavor: performance1-1
        image: bb02b1a3-bc77-4d17-ab5b-421d89850fca
        min_entities: 5
        max_entities: 10
        name: ASG Test
        server_name: asgtest
        loadbalancers:
            - id: 228385
              port: 80
      register: asg

Authors

  • Matt Martz (@sivel)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/rax_scaling_group_module.html