cce_node_pool

updated: None

cce_node_pool

Note

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

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 Choices/Defaults Comments
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.
autoscaling_enabled
boolean
    Choices:
  • no ←
  • yes
Enable or disable Autoscaling
availability_zone
string
Default:
"random"
Availability zone or 'random' for all zones
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 Node Pool
data_volumes
list / elements=dictionary
Default:
[{"cmk_id": "", "encrypted": false, "size": 100, "volumetype": "SATA"}]
List of data volumes attached to the cluster node.
ecs_group
string
ID of the ECS group where the CCE node can belong to.
flavor
string
Flavor ID of the cluster node
initial_node_count
integer
Expected number of nodes in this node pool.
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.
lvm_config
string
ConfigMap of the Docker data disk.
max_node_count
integer
Maximum number of nodes after scale-up.
max_pods
integer
Maximum number of pods on the node.
min_node_count
integer
Minimum number of nodes after a scale-down.
name
string / required
Name of the CCE Node Pool
network_id
string
ID of the network to which the CCE node pool belongs to.
node_image_id
string
Mandatory if custom image is used on a
bare metall node.
os
string
Operating System of the cluster node.
postinstall_script
string
Base64 encoded post installation script.
preinstall_script
string
Base64 encoded pre installation script.
priority
integer
Node pool weight for scale-up operations.
public_key
string
Additional public key to be added for login.
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.
scale_down_cooldown_time
integer
Interval in minutes during which nodes added after a scale-up will
not be deleted.
ssh_key
string
Name of the public key to login into the nodes
state
string
    Choices:
  • present ←
  • absent
Should the resource be present or absent.
tags
list / elements=dictionary
List of tags used to build UI labels.
taints
list / elements=dictionary
List of taints.
timeout
integer
Default:
180
How long should ansible wait for the requested resource.
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 ←
Should ansible wait until the requested resource is complete.

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 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_id: '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_id: '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 Returned Description
cce_node_pool
dictionary
On success when state=present
Dictionary describing the CCE Node Pool.

Sample:
{'api_version': 'v3', 'id': 'e2d0d5f3-572e-11eb-8fea-0255ac101123', 'kind': 'NodePool', 'metadata': None, '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': None}, 'node_pool_type': 'vm', 'node_template_spec': {'availability_zone': 'random', 'billing_mode': 0, 'count': None, 'data_volumes': [{'extend_params': None, 'metadata': None, 'size': 120, 'type': 'SSD'}, {'extend_params': None, 'metadata': None, 'size': 100, 'type': 'SATA'}], 'ecs_group': None, 'extend_params': {'lvm_config': None, 'max_pods': 110, 'node_image_id': None, 'postinstall_script': None, 'preinstall_script': None, 'public_key': 'ssh_pubkey_value'}, 'flavor': 's2.large.2', 'floating_ip': {'count': None, 'floating_ip_spec': {'bandwidth': {}}, 'ids': None}, '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': ''}}
id
string
On success when state=present
The CCE Node Pool UUID.

Sample:
39007a7e-ee4f-4d13-8283-b4da2e037123


Authors

  • Tino Schreiber (@tischrei)

updated: None