opentelekomcloud.cloud.cce_cluster (0.14.2) — module

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2

Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Add or Remove CCE Cluster in OTC.

Requirements

• openstacksdk
• openstacksdk >= 0.36.0
• otcextensions
• python >= 3.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 }}"

Inputs

    
auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(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.
    type: dict

name:
    description: Name that has to be given to the cluster.
    required: true
    type: str

type:
    choices:
    - virtualmachine
    default: virtualmachine
    description: Cluster type
    type: str

wait:
    default: 'yes'
    description:
    - If the module should wait for the cluster to be created or deleted.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

state:
    choices:
    - present
    - absent
    default: present
    description: Should the resource be present or absent.
    type: str

flavor:
    description: Cluster flavor name.
    type: str

router:
    description: Name or ID of the Neutron router.
    type: str

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

network:
    description: Name or ID of the Neutron network.
    type: str

timeout:
    default: 1800
    description:
    - The amount of time the module should wait.
    type: int

version:
    description: Version of the Kubernetes.
    type: str

auth_type:
    description:
    - 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 I(auth) parameter should be updated accordingly.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

api_timeout:
    description:
    - 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.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

description:
    description: Cluster description.
    type: str

external_ip:
    description: External IP to be assigned to the cluster.
    type: str

region_name:
    description:
    - Name of the region.
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

kube_proxy_mode:
    choices:
    - iptables
    - ipvs
    description: Service forwarding mode.
    type: str

service_ip_range:
    description: 'Service CIDR block or the IP address range which the

      kubernetes clusterIp must fall within.

      '
    type: str

availability_zone:
    description: Cluster AZ. Use 'multi_az' for spreading muster nodes across AZ.
    type: str

authentication_mode:
    choices:
    - rbac
    - x509
    - authenticating_proxy
    description: Cluster authentication mode.
    type: str

container_network_cidr:
    description: CIDR for the internal network.
    type: str

container_network_mode:
    choices:
    - overlay_l2
    - underlay_ipvlan
    - vpc-router
    description: Network type.
    type: str

authentication_proxy_ca:
    description: CA root certificate provided in the authenticating_proxy mode.
    type: str

Outputs

cce_cluster:
  contains:
    id:
      description: Unique UUID.
      sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
      type: str
    name:
      description: Name given to the load balancer.
      sample: elb_test
      type: str
  description: Dictionary describing the Cluster.
  returned: On success when C(state=present)
  type: complex
id:
  description: The CCE Cluster UUID.
  returned: On success when C(state=present)
  sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
  type: str