On this page
rax_cdb - create/delete or resize a Rackspace Cloud Databases instance
New in version 1.8.
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 (on host that executes module)
- python >= 2.6
- pyrax
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
api_key |
no |
Rackspace API key, overrides credentials.
aliases: password
|
||
cdb_type
(added in 2.0)
|
no | MySQL |
type of instance (i.e. MySQL, MariaDB, Percona)
aliases: type
|
|
cdb_version
(added in 2.0)
|
no |
|
version of database (MySQL supports 5.1 and 5.6, MariaDB supports 10, Percona supports 5.6)
aliases: version
|
|
credentials |
no |
File to find the Rackspace credentials in. Ignored if api_key and username are provided.
aliases: creds_file
|
||
env
(added in 1.5)
|
no |
Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
|
||
flavor |
no | 1 |
flavor to use for the instance 1 to 6 (i.e. 512MB to 16GB)
|
|
name |
no |
Name of the databases server instance
|
||
region |
no | DFW |
Region to create an instance in.
|
|
state |
no | present |
|
Indicate desired state of the resource
|
username |
no |
Rackspace username, overrides credentials.
|
||
verify_ssl
(added in 1.5)
|
no |
Whether or not to require SSL validation of API endpoints.
|
||
volume |
no | 2 |
Volume size of the database 1-150GB
|
|
wait |
no | no |
|
wait for the instance to be in state 'running' before returning
|
wait_timeout |
no | 300 |
how long before wait gives up, in seconds
|
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
Notes
Note
- The following environment variables can be used,
RAX_USERNAME
,RAX_API_KEY
,RAX_CREDS_FILE
,RAX_CREDENTIALS
,RAX_REGION
. RAX_CREDENTIALS
andRAX_CREDS_FILE
points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticatingRAX_USERNAME
andRAX_API_KEY
obviate the use of a credentials fileRAX_REGION
defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/rax_cdb_module.html