opentelekomcloud.cloud.cce_node_pool module – Add/Delete CCE Node Pool¶
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_node_pool.
New in version 0.5.0: of opentelekomcloud.cloud
Synopsis¶
Add or Remove CCE Node Pool 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 |
|---|---|
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. |
|
Enable or disable Autoscaling Choices:
|
|
Availability zone or ‘random’ for all zones Default: “random” |
|
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 Node Pool |
|
List of data volumes attached to the cluster node. Default: [{“cmk_id”: “”, “encrypted”: false, “size”: 100, “volumetype”: “SATA”}] |
|
ID of the ECS group where the CCE node can belong to. |
|
Flavor ID of the cluster node |
|
Expected number of nodes in this node pool. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Dictionary of Kubernetes tags. |
|
ConfigMap of the Docker data disk. |
|
Maximum number of nodes after scale-up. |
|
Maximum number of pods on the node. |
|
Minimum number of nodes after a scale-down. |
|
Name of the CCE Node Pool |
|
ID of the network to which the CCE node pool belongs to. |
|
Mandatory if custom image is used on a bare metall node. |
|
Operating System of the cluster node. |
|
Base64 encoded post installation script. |
|
Base64 encoded pre installation script. |
|
Node pool weight for scale-up operations. |
|
Additional public key to be added for login. |
|
Name of the region. |
|
Size of the root volume Default: 40 |
|
Type of the root volume. Choices:
|
|
Interval in minutes during which nodes added after a scale-up will not be deleted. |
|
Name of the public key to login into the nodes |
|
Should the resource be present or absent. Choices:
|
|
List of tags used to build UI labels. |
|
List of taints. |
|
How long should ansible wait for the requested resource. Default: 180 |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. 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 Node Pool with minimal configuration
- cce_node_pool:
cloud: "{{ test_cloud }}"
cluster: clustername
flavor: s2.large.2
os: 'CentOS 7.7'
name: my-nodepool
network: '25d24fc8-d019-4a34-9fff-0a09fde6a123'
ssh_key: 'ssh-pub'
state: present
register: pool
# Create CCE Node Pool with fine-grained configuration
- cce_node_pool:
cloud: "{{ test_cloud }}"
availability_zone: "random"
autoscaling_enabled: True
cluster: tino-test
data_volumes:
- volumetype: SSD
size: 120
- volumetype: SATA
size: 100
encrypted: False
cmk_id: ''
flavor: s2.large.2
initial_node_count: 0
k8s_tags:
mytag: myvalue
mysecondtag: mysecondvalue
min_node_count: 1
max_node_count: 3
name: test-ansible2
network: '25d24fc8-d019-4a34-9fff-0a09fde6a123'
priority: 2
os: 'CentOS 7.7'
scale_down_cooldown_time: 5
ssh_key: 'sshkey-pub'
tags:
- key: 'my_first_key'
value: 'my_first_value'
- key: 'my_second_key'
value: 'my_secound_value'
taints:
- key: 'first_taint_key'
value: 'first_taint_value'
effect: 'NoSchedule'
- key: 'second_taint_key'
value: 'secound_taint_value'
effect: 'NoExecute'
state: present
register: pool
# Delete CCE Node Pool
- opentelekomcloud.cloud.cce_node_pool:
cluster: "{{ cluster_name_or_id }}"
name: "{{ cce_node_pool_name_or_id }}"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Dictionary describing the CCE Node Pool. Returned: On success when Sample: {“api_version”: “v3”, “id”: “e2d0d5f3-572e-11eb-8fea-0255ac101123”, “kind”: “NodePool”, “metadata”: null, “name”: “test-ansible2”, “spec”: {“autoscaling”: {“enable”: true, “max_node_count”: 3, “min_node_count”: 1, “priority”: 2, “scale_down_cooldown_time”: 5}, “initial_node_count”: 0, “node_management”: {“ecs_group”: null}, “node_pool_type”: “vm”, “node_template_spec”: {“availability_zone”: “random”, “billing_mode”: 0, “count”: null, “data_volumes”: [{“extend_params”: null, “metadata”: null, “size”: 120, “type”: “SSD”}, {“extend_params”: null, “metadata”: null, “size”: 100, “type”: “SATA”}], “ecs_group”: null, “extend_params”: {“lvm_config”: null, “max_pods”: 110, “node_image_id”: null, “postinstall_script”: null, “preinstall_script”: null, “public_key”: “ssh_pubkey_value”}, “flavor”: “s2.large.2”, “floating_ip”: {“count”: null, “floating_ip_spec”: {“bandwidth”: {}}, “ids”: null}, “k8s_tags”: {“cce.cloud.com/cce-nodepool”: “nodepool-name”, “mysecondtag”: “mysecondvalue”, “mytag”: “myvalue”}, “login”: {“ssh_key”: “tischrei-pub”}, “node_nic_spec”: {“primary_nic”: {“network_id”: “25d24fc8-d019-4a34-9fff-0a09fde6a123”}}, “os”: “CentOS 7.7”, “root_volume”: {“size”: 40, “type”: “SATA”}, “tags”: [{“key”: “my_first_key”, “value”: “my_first_value”}, {“key”: “my_second_key”, “value”: “my_secound_value”}], “taints”: [{“effect”: “NoSchedule”, “key”: “first_taint_key”, “value”: “first_taint_value”}, {“effect”: “NoExecute”, “key”: “second_taint_key”, “value”: “secound_taint_value”}]}}, “status”: {“current_node”: 0, “status”: “”}} |
|
The CCE Node Pool UUID. Returned: On success when Sample: “39007a7e-ee4f-4d13-8283-b4da2e037123” |