opentelekomcloud.cloud.cce_cluster_node – Add/Delete CCE Cluster node

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.9.0).

To install it use: ansible-galaxy collection install opentelekomcloud.cloud.

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

New in version 0.4.0: of opentelekomcloud.cloud

Synopsis

• Add or Remove CCE Cluster node in OTC

Requirements

The below requirements are needed on the host that executes this module.

• openstacksdk

• openstacksdk >= 0.36.0

• otcextensions

• python >= 3.6

Parameters

Parameter	Choices/Defaults	Comments
annotations dictionary		Specifiy annotations for CCE node
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		Availability zone
ca_cert string		A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert
client_cert string		A path to a client certificate to use as part of the SSL transaction. aliases: cert
client_key string		A path to a client key to use as part of the SSL transaction. aliases: key
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.
cluster string		CCE cluster name or id which hosts the cce cluster node
count integer	Default: 1	Cluster node count which will be created. If node count is greater than 1 the name of the node gets a suffix.
data_volumes list / elements=dictionary		List of data volumes attached to the cluster node.
dedicated_host string		ID of a Dedicated Host where the cluster node will be located to.
ecs_group string		ID of the ECS group where the CCE node can belong to.
fault_domain string		The node is created in the specified fault domain.
flavor string		Flavor ID of the cluster node
floating_ip string		Floating IP used to connect to public networks.
interface string	Choices: admin internal public ←	Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
k8s_tags dictionary		Dictionary of Kubernetes tags.
keypair string		Name of the public key to login
labels dictionary		Labels for the CCE cluster node
lvm_config string		ConfigMap of the Docker data disk.
max_pods integer		Maximum number of pods on the node.
name string / required		Name of the CCE cluster node.
node_image_id string		ID of a custom image used in a baremetall scenario.
offload_node boolean	Choices: no yes	If node is offloading its components.
os string		Operating System of the cluster node.
postinstall_script string		Base64 encoded post installation script.
preinstall_script string		Base64 encoded pre installation script.
region_name string		Name of the region.
root_volume_size integer	Default: 40	Size of the root volume
root_volume_type string	Choices: SATA ← SAS SSD	Type of the root volume.
state string	Choices: present ← absent	Should the resource be present or absent.
tags list / elements=dictionary		CCE cluster node tags
timeout integer	Default: 180	The amount of time the module should wait.
validate_certs boolean	Choices: no ← yes	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. aliases: verify
wait boolean	Choices: no yes ←	If the module should wait for the cluster node to be created or deleted.

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

# Create CCE cluster node
- opentelekomcloud.cloud.cce_cluster_node:
    annotations:
      annotation1: 'abc'
    availability_zone: 'eu-de-02'
    cluster: "{{ cluster_name_or_id }}"
    count: 1
    data_volumes:
      - SATA: 150
      - SAS: 100
    flavor: 's2.large.2'
    k8s_tags:
      testtag: 'value'
    keypair: 'sshkey-pub'
    labels:
      mein: 'label'
    max_pods: 16
    name: "{{ cce_node_name }}"
    os: 'CentOS 7.7'
    root_volume_size: 40
    root_volume_type: SATA
    tags:
      - key: 'key1'
        value: 'value1'
      - key: 'key2'
        value: 'value2'
    wait: true
    state: present

# Delete CCE cluster node
- opentelekomcloud.cloud.cce_cluster_node:
    cluster: "{{ cluster_name_or_id }}"
    name: "{{ cce_node_name }}"
    state: absent

Return Values

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

Key	Returned	Description
cce_cluster_node dictionary	On success when state=present	Dictionary describing the Cluster Node. Sample: {'cce_cluster_node': {'api_version': 'v3', 'id': 'a815a926-30cd-11eb-b02d-0255ac101123', 'kind': 'Node', 'location': {'cloud': 'otc', 'project': {'domain_id': None, 'domain_name': None, 'id': '16d53a84a13b49529d2e2c3646691123', 'name': 'eu-de'}, 'region_name': 'eu-de', 'zone': None}, 'metadata': {'annotations': {'annotation1': 'abc'}, 'created_at': None, 'id': 'a815a926-30cd-11eb-b02d-0255ac101123', 'labels': {'mein': 'label'}, 'location': None, 'name': 'testccenode', 'updated_at': None}, 'name': 'testccenode', 'spec': {'availability_zone': 'eu-de-02', 'billing_mode': 0, 'count': 1, 'data_volumes': [{'id': None, 'location': None, 'name': None, 'size': 150, 'type': 'SATA'}, {'id': None, 'location': None, 'name': None, 'size': 100, 'type': 'SAS'}], 'dedicated_host': None, 'ecs_group': None, 'extend_params': {'id': None, 'location': None, 'lvm_config': None, 'max_pods': 16, 'name': None, 'node_image_id': None, 'postinstall_script': None, 'preinstall_script': None}, 'fault_domain': None, 'flavor': 's2.large.2', 'floating_ip': {'count': None, 'floating_ip': {'bandwidth': {}}, 'id': None, 'ids': None, 'location': None, 'name': None}, 'id': None, 'k8s_tags': {'kubernetes.io/eniquota': '12', 'kubernetes.io/subeniquota': '0', 'testtag': 'value'}, 'location': None, 'login': {'sshKey': 'sshkey-pub', 'userPassword': {}}, 'name': None, 'offload_node': None, 'os': 'CentOS 7.7', 'root_volume': {'id': None, 'location': None, 'name': None, 'size': 40, 'type': 'SATA'}, 'tags': [{'id': None, 'key': 'hellokey1', 'location': None, 'name': None, 'value': 'hellovalue1'}, {'id': None, 'key': 'hellokey2', 'location': None, 'name': None, 'value': 'hellovalue2'}], 'taints': None}, 'status': {'floating_ip': None, 'id': None, 'instance_id': None, 'job_id': 'a8168c15-30cd-11eb-b02d-0255ac101123', 'location': None, 'name': None, 'private_ip': None, 'status': None}}}
id string	On success when state=present	The CCE Cluster Node UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037123

Authors

• Tino Schreiber (@tischrei)