opentelekomcloud.cloud.cce_cluster module -- Add/Delete CCE Cluster

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.

New in opentelekomcloud.cloud 0.0.1

Synopsis

  • Add or Remove CCE Cluster 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

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.

authentication_mode

string

Cluster authentication mode.

Choices:

  • "rbac"

  • "x509"

  • "authenticating_proxy"

authentication_proxy_ca

string

CA root certificate provided in the authenticating_proxy mode.

availability_zone

string

Cluster AZ. Use 'multi_az' for spreading muster nodes across AZ.

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.

container_network_cidr

string

CIDR for the internal network.

container_network_mode

string

Network type.

Choices:

  • "overlay_l2"

  • "underlay_ipvlan"

  • "vpc-router"

description

string

Cluster description.

external_ip

string

External IP to be assigned to the cluster.

flavor

string

Cluster flavor name.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

kube_proxy_mode

string

Service forwarding mode.

Choices:

  • "iptables"

  • "ipvs"

name

string / required

Name that has to be given to the cluster.

network

string

Name or ID of the Neutron network.

region_name

string

Name of the region.

router

string

Name or ID of the Neutron router.

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

service_ip_range

string

Service CIDR block or the IP address range which the kubernetes clusterIp must fall within.

state

string

Should the resource be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

timeout

integer

The amount of time the module should wait.

Default: 1800

type

string

Cluster type

Choices:

  • "virtualmachine" ← (default)

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

version

string

Version of the Kubernetes.

wait

boolean

If the module should wait for the cluster 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

- name: Create cluster
  opentelekomcloud.cloud.cce:
    name: "{{ cce_cluster_name }}"
    flavor: "{{ cce_flavor }}"
    description: "Ansible collection test"
    router: "{{ router_name }}"
    network: "{{ network_name }}"
    container_network_mode: "{{ container_network_mode }}"

Return Values

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

Key

Description

cce_cluster

complex

Dictionary describing the Cluster.

Returned: On success when state=present

id

string

Unique UUID.

Returned: success

Sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"

name

string

Name given to the load balancer.

Returned: success

Sample: "elb_test"

id

string

The CCE Cluster UUID.

Returned: On success when state=present

Sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"

Authors

  • Artem Goncharov (@gtema)

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