opentelekomcloud.cloud.dds_instance (0.14.2) — module

Manage DDS instance

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

Authors: Yustina Kvrivishvili (@YustinaKvr)

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 DDS instances.


Requirements

Usage examples

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

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

mode:
    choices:
    - Sharding
    - ReplicaSet
    description:
    - Specifies the instance type. Cluster, replica set instances are supported.
    type: str

name:
    description:
    - 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.
    type: str

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    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

region:
    description:
    - Specifies the region ID.
    - The value cannot be empty.
    type: str

router:
    description:
    - Specifies the VPC ID. The value cannot be empty.
    - The string length and whether the string complying with UUID regex rules are verified.
    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

flavors:
    description:
    - Specifies the instance specifications.
    elements: dict
    suboptions:
      num:
        description: Specifies node quantity.
        type: int
      size:
        description:
        - 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.
        type: int
      spec_code:
        description: Specifies the resource specification code.
        type: str
      storage:
        default: ULTRAHIGH
        description:
        - Specifies the disk type. This parameter is optional for all nodes except mongos.
        - This parameter is invalid for the mongos nodes.
        type: str
      type:
        choices:
        - mongos
        - shard
        - config
        - replica
        description:
        - 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
        type: str
    type: list

network:
    description: Specifies the subnet ID.
    type: str

timeout:
    default: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

password:
    description:
    - Specifies the database password. The value must be 8 to 32 characters in length,
    - contain uppercase and lowercase letters, digits and special characters.
    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

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

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

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

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

security_group:
    description: Specifies the ID of the security group where a specified DB instance
      belongs to.
    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:
    - Specifies the number of days to retain the generated backup files.
    - The value range is from 0 to 732.
    type: int

disk_encryption:
    description:
    - 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.
    type: str

backup_timeframe:
    description:
    - Specifies the backup time window.
    - Automated backups will be triggered during the backup time window. Value cannot
      be empty.
    type: str

availability_zone:
    description:
    - Specifies the AZ ID.
    - The value cannot be empty.
    type: str

datastore_version:
    choices:
    - '3.2'
    - '3.4'
    default: '3.4'
    description: Specifies the database version.
    type: str

Outputs

dds_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 DDS Instance.
  returned: On Success.
  type: complex