community.general.rax_cdb – create/delete or resize a Rackspace Cloud Databases instance

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_cdb.

Synopsis

creates / deletes or resize a Rackspace Cloud Databases instance and optionally waits for it to be ‘running’. The name option needs to be unique since it’s used to identify the instance.

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/
cdb_type string	Default: "MySQL"	type of instance (i.e. MySQL, MariaDB, Percona) aliases: type
cdb_version string	Default: 5.6	version of database (MySQL supports 5.1 and 5.6, MariaDB supports 10, Percona supports 5.6) The available choices are: `5.1`, `5.6` and `10`. aliases: version
credentials path		File to find the Rackspace credentials in. Ignored if api_key and username are provided. aliases: creds_file
env string		Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
flavor integer	Default: 1	flavor to use for the instance 1 to 6 (i.e. 512MB to 16GB)
identity_type string	Default: "rackspace"	Authentication mechanism to use, such as rackspace or keystone.
name string / required		Name of the databases server instance
region string		Region to create an instance in.
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.
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
volume integer	Default: 2	Volume size of the database 1-150GB
wait boolean	Choices: no ← yes	wait for the instance to be in state 'running' before returning
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

- name: Build a Cloud Databases
  gather_facts: False
  tasks:
    - name: Server build request
      local_action:
        module: rax_cdb
        credentials: ~/.raxpub
        region: IAD
        name: db-server1
        flavor: 1
        volume: 2
        cdb_type: MySQL
        cdb_version: 5.6
        wait: yes
        state: present
      register: rax_db_server

Authors

Simon JAILLET (@jails)

© 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_cdb_module.html

Docs

Docs4dev

Title here