community.general.rax_cdb module – Create/delete or resize a Rackspace Cloud Databases instance
Note
This module is part of the community.general collection (version 5.8.3).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
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 |
Comments |
---|---|
Rackspace API key, overrides credentials. |
|
The URI of the authentication service. If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/ |
|
type of instance (i.e. MySQL, MariaDB, Percona) Default: |
|
version of database (MySQL supports 5.1 and 5.6, MariaDB supports 10, Percona supports 5.6) The available choices are: Default: |
|
File to find the Rackspace credentials in. Ignored if api_key and username are provided. |
|
Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration. |
|
flavor to use for the instance 1 to 6 (i.e. 512MB to 16GB) Default: |
|
Authentication mechanism to use, such as rackspace or keystone. Default: |
|
Name of the databases server instance |
|
Region to create an instance in. |
|
Indicate desired state of the resource Choices:
|
|
The tenant ID used for authentication. |
|
The tenant name used for authentication. |
|
Rackspace username, overrides credentials. |
|
Whether or not to require SSL validation of API endpoints. Choices:
|
|
Volume size of the database 1-150GB Default: |
|
wait for the instance to be in state ‘running’ before returning Choices:
|
|
how long before wait gives up, in seconds Default: |
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, …)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, …)
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: true
state: present
register: rax_db_server
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication