opentelekomcloud.cloud.dws_cluster module -- Manage dws clusters¶
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.dws_cluster.
New in opentelekomcloud.cloud 0.14.4
Synopsis¶
Manage dws cluster.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
openstacksdk >= 0.36.0
Parameters¶
Parameter |
Comments |
|---|---|
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. |
|
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. |
|
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 of a cluster. |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
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. |
|
Cluster flavor (node type). |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Cluster name. It contains 4 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. The value must start with a letter. |
|
Name or ID of the neutron network |
|
Number of deployed CNs. The value ranges from 2 to the number of cluster nodes. The maximum value is 20 and the default value is 3. |
|
Number of cluster nodes. For a cluster, the value ranges from 3 to 256. For a hybrid data warehouse (standalone), the value is 1. |
|
Administrator password for logging in to a GaussDB(DWS) cluster. Contains 12 to 32 characters. Contains at least three types of the following characters uppercase letters, lowercase letters, digits, and special characters. Cannot be the same as the username or the username written in reverse order. |
|
Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000. |
|
Public IP address. If the parameter is not specified, public connection is not used by default. |
|
Elastic IP address or ID. |
|
Binding type of an EIP. Choices:
|
|
Name of the region. |
|
Name or ID of the Neutron router (VPC) |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Name or ID of the security group |
|
Instance state Choices:
|
|
Tags in a cluster. |
|
Tag key. The value can contain 1 to 36 characters. Only digits, letters, hyphens (-) and underscores (_) are allowed. |
|
Tag value. The value can contain 0 to 43 characters. Only digits, letters, hyphens (-) and underscores (_) are allowed. |
|
The amount of time the module should wait for the cluster to get into active state. Default: |
|
Administrator username for logging in to a GaussDB(DWS) cluster. The administrator username must- Consist of lowercase letters, digits, or underscores. Start with a lowercase letter or an underscore. Contain 1 to 63 characters. Cannot be a keyword of the GaussDB(DWS) database. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
If the module should wait for the cluster to be created. Choices:
|
Notes¶
Note
The standard OpenStack environment variables, such as
OS_USERNAMEmay 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¶
#Create dws Cluster
---
- hosts: localhost
tasks:
- name: Create dws cluster
opentelekomcloud.cloud.dws_cluster:
name: DWS-Test
state: present
num_cn: 2
num_nodes: 3
router: '{{ router_id }}'
network: '{{ network_id }}'
security_group: '{{ security_group_id }}'
flavor: 'dws.xlarge.2'
username: dbadmin
password: 'SecretPassword'
port: 8000
timeout: 1200
tags:
- key: "key0"
value: "value0"
- key: "key1"
value: "value1"
#Delete dws Cluster
- hosts: localhost
tasks:
- name: Delete dws cluster
opentelekomcloud.cloud.dws_cluster:
name: dws-test
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Dictionary of dws cluster Returned: changed Sample: |