opentelekomcloud.cloud.css_cluster module -- Manage CSS 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.css_cluster.
New in opentelekomcloud.cloud 0.9.0
Synopsis¶
Manage CSS clusters
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
openstacksdk >= 0.36.0
Parameters¶
Parameter |
Comments |
|---|---|
Password of the cluster user admin in security mode. This parameter is mandatory only when authority_enable is set to true. The password can contain 8 to 32 characters. Passwords must contain at least 3 of the following character types uppercase letters, lowercase letters, numbers, and special characters (~!@#$%^&*()-_=+\|[{}];:,<.>/?). |
|
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. |
|
Whether to enable authentication. Available values include true and false. Authentication is disabled by default. When authentication is enabled, httpsEnable must be set to true. Choices:
|
|
Automatic snapshot creation. This function is disabled by default. |
|
IAM agency used to access OBS. |
|
Storage path of the snapshot in the OBS bucket. |
|
OBS bucket used for storing backup. If there is snapshot data in an OBS bucket, only the OBS bucket will be used for backup storage and cannot be changed. |
|
Number of days for which automatically created snapshots are reserved. Value range is 1 to 90 |
|
Time when a snapshot is created every day. Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, HH:mm refers to the hour time and z refers to the time zone, for example, 00:00 GMT+08:00 and 01:00 GMT+08:00. |
|
Prefix of the name of the snapshot that is automatically created. |
|
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. |
|
Datastore type Choices:
|
|
Datastore version. |
|
Instance flavor name. |
|
Whether communication is encrypted on the cluster. Available values include true and false. By default, communication is encrypted. Value true indicates that communication is encrypted on the cluster. Value false indicates that communication is not encrypted on the cluster. Choices:
|
|
Number of clusters. The value range is 1 to 32. |
|
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. |
|
Subnet ID. All instances in a cluster must have the same subnets and security groups. |
|
Name of the region. |
|
VPC ID, which is used for configuring cluster network. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Security group ID. All instances in a cluster must have the same subnets and security groups. |
|
Instance state Choices:
|
|
Key ID. The Default Master Keys cannot be used to create grants. Specifically, you cannot use Default Master Keys whose aliases end with /default in KMS to create clusters. After a cluster is created, do not delete the key used by the cluster. Otherwise, the cluster will become unavailable. |
|
Value 1 indicates encryption is performed Value 0 indicates encryption is not performed. 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: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Volume size, which must be a multiple of 4 and 10. Unit GB |
|
Information about the volume. COMMON Common I/O HIGH High I/O ULTRAHIGH Ultra-high I/O 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 CSS Cluster
---
- hosts: localhost
tasks:
- name: Create CSS cluster
opentelekomcloud.cloud.css_cluster:
name: ES-Test
state: present
instance_num: 3
volume_size: 40
authority_enable: false
volume_type: common
router: '{{ router_id }}'
net: '{{ net_id }}'
security_group: '{{ security_group_id }}'
flavor: 'css.xlarge.2'
https_enable: false
system_encrypted: 0
timeout: 1200
tags:
- key: "key0"
value: "value0"
- key: "key1"
value: "value1"
backup_strategy:
period: "00:00 GMT+03:00"
prefix: "yetanother"
keepday: 1
agency: "css-agency"
bucket: "css-bucket"
basepath: "css-test"
#Delete CSS Cluster
- hosts: localhost
tasks:
- name: Create CSS cluster
opentelekomcloud.cloud.css_cluster:
name: ES-Test
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Dictionary of CSS cluster Returned: changed Sample: |