community.general.rax_cdb (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

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

• pyrax

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
env:
    description:
    - Environment as configured in C(~/.pyrax.cfg), see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
    type: str

name:
    description:
    - Name of the databases server instance
    required: true
    type: str

wait:
    default: false
    description:
    - wait for the instance to be in state 'running' before returning
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Indicate desired state of the resource
    type: str

flavor:
    default: 1
    description:
    - flavor to use for the instance 1 to 6 (i.e. 512MB to 16GB)
    type: int

region:
    description:
    - Region to create an instance in.
    type: str

volume:
    default: 2
    description:
    - Volume size of the database 1-150GB
    type: int

api_key:
    aliases:
    - password
    description:
    - Rackspace API key, overrides O(credentials).
    type: str

cdb_type:
    aliases:
    - type
    default: MySQL
    description:
    - type of instance (i.e. MySQL, MariaDB, Percona)
    type: str

username:
    description:
    - Rackspace username, overrides O(credentials).
    type: str

tenant_id:
    description:
    - The tenant ID used for authentication.
    type: str

cdb_version:
    aliases:
    - version
    default: '5.6'
    description:
    - version of database (MySQL supports 5.1 and 5.6, MariaDB supports 10, Percona supports
      5.6)
    - 'The available choices are: V(5.1), V(5.6) and  V(10).'
    type: str

credentials:
    aliases:
    - creds_file
    description:
    - File to find the Rackspace credentials in. Ignored if O(api_key) and O(username)
      are provided.
    type: path

tenant_name:
    description:
    - The tenant name used for authentication.
    type: str

wait_timeout:
    default: 300
    description:
    - how long before wait gives up, in seconds
    type: int

auth_endpoint:
    description:
    - The URI of the authentication service.
    - If not specified will be set to U(https://identity.api.rackspacecloud.com/v2.0/).
    type: str

identity_type:
    default: rackspace
    description:
    - Authentication mechanism to use, such as rackspace or keystone.
    type: str

validate_certs:
    aliases:
    - verify_ssl
    description:
    - Whether or not to require SSL validation of API endpoints.
    type: bool