opentelekomcloud.cloud.dds_instance module – Manage DDS instance¶

Note

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

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 opentelekomcloud.cloud.

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

New in version 0.0.2: of opentelekomcloud.cloud

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Manage DDS 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	Specifies the AZ ID. The value cannot be empty.
backup_keepdays integer	Specifies the number of days to retain the generated backup files. The value range is from 0 to 732.
backup_timeframe string	Specifies the backup time window. Automated backups will be triggered during the backup time window. Value cannot be empty.
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 raw	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.
datastore_version string	Specifies the database version. Choices: 3.2 3.4 ← (default)
disk_encryption string	Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules. If this parameter is not transferred, disk encryption is not performed.
flavors list / elements=dictionary	Specifies the instance specifications.
num integer	Specifies node quantity.
size integer	Specifies the disk size. This parameter is mandatory for all nodes except mongos. This parameter is invalid for the mongos nodes. For a cluster instance, the storage space of a shard node can be 10 to 1000 GB, and the config storage space is 20 GB. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes. For a replica set instance, the value ranges from 10 to 2000.
spec_code string	Specifies the resource specification code.
storage string	Specifies the disk type. This parameter is optional for all nodes except mongos. This parameter is invalid for the mongos nodes. Default: “ULTRAHIGH”
type string	Specifies the node type. For a replica set instance, the value is replica. For a cluster instance, the value can be mongos, shard, or config Choices: mongos shard config replica
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: admin internal public ← (default)
mode string	Specifies the instance type. Cluster, replica set instances are supported. Choices: Sharding ReplicaSet
name string	Specifies the DB instance name. The DB instance name of the same DB engine is unique for the same tenant. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens, and underscores.
network string	Specifies the subnet ID.
password string	Specifies the database password. The value must be 8 to 32 characters in length, contain uppercase and lowercase letters, digits and special characters.
region string	Specifies the region ID. The value cannot be empty.
region_name string	Name of the region.
router string	Specifies the VPC ID. The value cannot be empty. The string length and whether the string complying with UUID regex rules are verified.
security_group string	Specifies the ID of the security group where a specified DB instance belongs to.
ssl_option integer	Specifies whether to enable SSL. The value 0 indicates that SSL is disabled, 1 - enabled. If this parameter is not transferred, SSL is enabled by default.
state string	Instance state Choices: present ← (default) absent
timeout integer	How long should ansible wait for the requested resource. Default: 180
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. Choices: no ← (default) yes
wait boolean	Should ansible wait until the requested resource is complete. Choices: no yes ← (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: Create DDS Instance
  opentelekomcloud.cloud.dds_instance:
    name: "{{ instance_name }}"
    datastore_version: "3.4"
    region: "eu-de"
    availability_zone: "eu-de-01"
    router: "{{ router_name }}"
    mode: "ReplicaSet"
    network: "{{ network_name }}"
    security_group: "default"
    password: "Test@123"
    flavors:
      - type: "replica"
        num: 1
        storage: "ULTRAHIGH"
        size: 10
        spec_code: "dds.mongodb.s2.medium.4.repset"
    backup_timeframe: "00:00-01:00"
    backup_keepdays: 7
    ssl_option: 1
    state: present

Return Values ¶

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

Key	Description
dds_instance complex	List of dictionaries describing DDS 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¶

Yustina Kvrivishvili (@YustinaKvr)

Whats next

opentelekomcloud.cloud.dds_datastore_info module – Obtain database version information about a specified type of a DB instance.

last updated: 2022-02-25 12:26

opentelekomcloud.cloud.dds_instance module – Manage DDS instance¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶