opentelekomcloud.cloud.rds_instance (0.14.2) — module

Manage RDS instance

| "added in version" 0.0.2 of opentelekomcloud.cloud"

Authors: Artem Goncharov (@gtema)

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2


Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Manage RDS instances.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(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.
    type: dict

name:
    description: Instance name or ID
    required: true
    type: str

port:
    description: Database port
    type: int

wait:
    default: 'yes'
    description:
    - If the module should wait for the instance to be created.
    type: bool

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

state:
    choices:
    - present
    - absent
    default: present
    description: Instance state
    type: str

flavor:
    description:
    - Instance specification code
    - Mandatory for new instance
    type: str

region:
    default: eu-de
    description: Database region
    type: str

router:
    description: Name or ID of the Neutron router (VPC)
    type: str

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

ha_mode:
    choices:
    - async
    - semisync
    - sync
    description: Replication mode for the HA type
    type: str

network:
    description: Name or ID of the neutron network
    type: str

timeout:
    default: 600
    description:
    - The amount of time the module should wait for the instance to get into active state.
    type: int

password:
    description: Database password
    type: str

auth_type:
    description:
    - 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 I(auth) parameter should be updated accordingly.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

replica_of:
    description: Instance ID to create the replica of
    type: str

api_timeout:
    description:
    - 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.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

region_name:
    description:
    - Name of the region.
    type: str

volume_size:
    description:
    - Size of the volume
    - Mandatory for new instance
    type: int

volume_type:
    description: '- Type of the volume

      - Supported values: common, ultrahigh

      - Mandatory for new instance

      '
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

configuration:
    description: Parameter template
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

datastore_type:
    choices:
    - mysql
    - postgresql
    - sqlserver
    default: postgresql
    description: Datastore type
    type: str

security_group:
    description: Name or ID of the security group
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

backup_keepdays:
    description:
    - Retention days for the backup files
    - Must be specified together with backup_timeframe
    type: int

disk_encryption:
    description: KMS ID
    type: str

backup_timeframe:
    description:
    - Backup time window in HH:MM-HH:MM format UTC time
    - Must be specified together with backup_keepdays
    type: str

availability_zone:
    description:
    - Instance availability zone.
    - Can be a CSV list (i.e. eu-de-01,eu-de-02)
    - Mandatory for creating instance
    type: str

datastore_version:
    description: Datastore version
    type: str

Outputs

rds_instance:
  contains:
    id:
      description: Unique UUID.
      sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
      type: str
    name:
      description: Name (version) of the instance.
      sample: test
      type: str
  description: List of dictionaries describing RDS Instance.
  returned: On Success.
  type: complex