opentelekomcloud.cloud.cce_cluster_node module -- Add/Delete CCE Cluster node

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.cce_cluster_node.

New in opentelekomcloud.cloud 0.4.0

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	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 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 any	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 / required	CCE cluster name or id which hosts the cce cluster node
count integer	Cluster node count which will be created. If node count is greater than 1 the name of the node gets a suffix. Default: 1
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 aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: "admin" "internal" "public" ← (default)
k8s_tags dictionary	Dictionary of Kubernetes tags.
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.
network string	Network ID of the CCE cluster node.
node_image_id string	ID of a custom image used in a baremetall scenario.
offload_node boolean	If node is offloading its components. Choices: false true
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	Size of the root volume Default: 40
root_volume_type string	Type of the root volume. Choices: "SATA" ← (default) "SAS" "SSD"
sdk_log_level string	Log level of the OpenStackSDK Choices: "ERROR" "WARN" ← (default) "INFO" "DEBUG"
sdk_log_path string	Path to the logfile of the OpenStackSDK. If empty no log is written
ssh_key string	Name of the public key to login
state string	Should the resource be present or absent. Choices: "present" ← (default) "absent"
tags list / elements=dictionary	CCE cluster node tags
timeout integer	The amount of time the module should wait. 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: false true
wait boolean	If the module should wait for the cluster node to be created or deleted. Choices: false true ← (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

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

Authors

• Tino Schreiber (@tischrei)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)

last updated: 2024-11-15 11:10 UTC - commit: 50bda984453bb05944b37f6d85b6380fcf26d10b