opentelekomcloud.cloud.cce_cluster_node module – Add/Delete CCE Cluster node¶
Note
This module is part of the opentelekomcloud.cloud collection (version 0.11.0).
You might already have this collection installed if you are using the ansible package.
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.
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 |
Comments |
|---|---|
Specifiy annotations for CCE node |
|
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 |
|
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. |
|
CCE cluster name or id which hosts the cce cluster node |
|
Cluster node count which will be created. If node count is greater than 1 the name of the node gets a suffix. Default: 1 |
|
List of data volumes attached to the cluster node. |
|
ID of a Dedicated Host where the cluster node will be located to. |
|
ID of the ECS group where the CCE node can belong to. |
|
The node is created in the specified fault domain. |
|
Flavor ID of the cluster node |
|
Floating IP used to connect to public networks. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Dictionary of Kubernetes tags. |
|
Labels for the CCE cluster node |
|
ConfigMap of the Docker data disk. |
|
Maximum number of pods on the node. |
|
Name of the CCE cluster node. |
|
Network ID of the CCE cluster node. |
|
ID of a custom image used in a baremetall scenario. |
|
If node is offloading its components. Choices:
|
|
Operating System of the cluster node. |
|
Base64 encoded post installation script. |
|
Base64 encoded pre installation script. |
|
Name of the region. |
|
Size of the root volume Default: 40 |
|
Type of the root volume. Choices:
|
|
Name of the public key to login |
|
Should the resource be present or absent. Choices:
|
|
CCE cluster node tags |
|
The amount of time the module should wait. Default: 180 |
|
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 node to be created or deleted. 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 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 |
|---|---|
Dictionary describing the Cluster Node. Returned: On success when 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}}} |
|
The CCE Cluster Node UUID. Returned: On success when Sample: “39007a7e-ee4f-4d13-8283-b4da2e037123” |