opentelekomcloud.cloud.rds_instance module -- Manage RDS instance

Note

This module is part of the opentelekomcloud.cloud collection (version 0.14.6).

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 opentelekomcloud.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: opentelekomcloud.cloud.rds_instance.

New in opentelekomcloud.cloud 0.0.2

Synopsis

  • Manage RDS instances.

Requirements

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

  • openstacksdk

  • openstacksdk >= 0.36.0

  • otcextensions

  • python >= 3.6

Parameters

Parameter

Comments

api_timeout

integer

How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.

auth

dictionary

Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.

auth_type

string

Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.

availability_zone

string

Instance availability zone.

Can be a CSV list (i.e. eu-de-01,eu-de-02)

Mandatory for creating instance

backup_keepdays

integer

Retention days for the backup files

Must be specified together with backup_timeframe

backup_timeframe

string

Backup time window in HH:MM-HH:MM format UTC time

Must be specified together with backup_keepdays

ca_cert

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

cloud

any

Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.

configuration

string

Parameter template

datastore_type

string

Datastore type

Choices:

  • "mysql"

  • "postgresql" ← (default)

  • "sqlserver"

datastore_version

string

Datastore version

disk_encryption

string

KMS ID

flavor

string

Instance specification code

Mandatory for new instance

ha_mode

string

Replication mode for the HA type

Choices:

  • "async"

  • "semisync"

  • "sync"

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

name

string / required

Instance name or ID

network

string

Name or ID of the neutron network

password

string

Database password

port

integer

Database port

region

string

Database region

Default: "eu-de"

region_name

string

Name of the region.

replica_of

string

Instance ID to create the replica of

router

string

Name or ID of the Neutron router (VPC)

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "ERROR"

  • "WARN" ← (default)

  • "INFO"

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

security_group

string

Name or ID of the security group

state

string

Instance state

Choices:

  • "present" ← (default)

  • "absent"

timeout

integer

The amount of time the module should wait for the instance to get into active state.

Default: 600

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • false

  • true

volume_size

integer

Size of the volume

Mandatory for new instance

volume_type

string

  • Type of the volume

  • Supported values: common, ultrahigh

  • Mandatory for new instance

wait

boolean

If the module should wait for the instance to be created.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

  • Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

- name: provision rds instance
  opentelekomcloud.cloud.rds_instance:
    name: "{{ instance_name }}"
    datastore_type: "mysql"
    datastore_version: "8.0"
    flavor: "{{ rds_flavor }}"
    router: "{{ router_name }}"
    network: "{{ network_name }}"
    security_group: "default"
    volume_type: "common"
    volume_size: 100
    password: "Test@123"
    region: "eu-de"
    availability_zone: "eu-de-01"
    timeout: 600

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

rds_instance

complex

List of dictionaries describing RDS Instance.

Returned: On Success.

id

string

Unique UUID.

Returned: success

Sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"

name

string

Name (version) of the instance.

Returned: success

Sample: "test"

Authors

  • Artem Goncharov (@gtema)

last updated: 2024-11-15 11:10 UTC - commit: 50bda984453bb05944b37f6d85b6380fcf26d10b