kowabunga.cloud.konvey module – Manage Kowabunga load balancers

Note

This module is part of the kowabunga.cloud collection (version 0.1.0).

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 kowabunga.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: kowabunga.cloud.konvey.

Synopsis

• Create, update or delete a Kowabunga Konvey load balancer.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.8

• kowabunga >= 0.52.5

Parameters

Parameter	Comments
api_key string / required	Private API key used to connect with specified Kowabunga Kahuna endpoint. Recommended to be encrypted using Ansible Vault or SOPS.
description string	Description for the load balancer.
endpoint string / required	HTTPS(S) URI of the Kowabunga Kahuna endpoint. Should be formatted as https://kowabunga.acme.com for example.
endpoints list / elements=string / required	List of endpoint definitions. Each endpoint requires name, port, protocol (tcp/udp), and backends dict with addresses list and optionally port.
failover boolean	Whether to enable failover for the load balancer. Choices: false true ← (default)
name string / required	Name for the load balancer. This attribute cannot be updated.
project string / required	Name (or ID) of the project where the load balancer will be created.
state string	Should the resource be present or absent. Choices: "present" ← (default) "absent"
zone string / required	Name (or ID) of the availability zone where the load balancer will be created.

Examples

- name: Create a load balancer
  kowabunga.cloud.konvey:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: lb-01
    endpoints:
      - name: http
        port: 80
        protocol: tcp
        backends:
          addresses:
            - 192.168.1.10
            - 192.168.1.11
    project: my-project
    zone: eu-west-1a

- name: Delete a load balancer
  kowabunga.cloud.konvey:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: lb-01
    project: my-project
    zone: eu-west-1a
    state: absent

Return Values

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

Key	Description
konvey dictionary	Dictionary describing the load balancer. Returned: On success when state is present.
description string	Konvey description Returned: success Sample: "Load balancer 01"
endpoints list / elements=string	List of endpoint configurations Returned: success
failover boolean	Failover enabled Returned: success Sample: true
id string	Konvey ID Returned: success Sample: "6850281677f2462b6919dbe5"
name string	Konvey name Returned: success Sample: "lb-01"
vip string	Virtual IP address Returned: success Sample: "192.168.1.100"

Authors

• The Kowabunga Project

Collection links

• Repository (Sources)