kowabunga.cloud.pool module – Manage Kowabunga storage pools

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.pool.

Synopsis

• Create, update or delete a Kowabunga storage pool.

Requirements

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

• python >= 3.8

• kowabunga >= 0.52.5

Parameters

Parameter	Comments
agents list / elements=string / required	List of agent names (or IDs) managing this storage pool.
api_key string / required	Private API key used to connect with specified Kowabunga Kahuna endpoint. Recommended to be encrypted using Ansible Vault or SOPS.
ceph_address string	Ceph cluster address. Default: "localhost"
ceph_port integer	Ceph cluster port. Default: 3300
ceph_secret_uuid string	Ceph secret UUID for authentication.
description string	Description for the storage pool.
endpoint string / required	HTTPS(S) URI of the Kowabunga Kahuna endpoint. Should be formatted as https://kowabunga.acme.com for example.
name string / required	Name for the storage pool. This attribute cannot be updated.
pool string / required	Name of the underlying Ceph storage pool. This attribute cannot be updated.
region string / required	Name (or ID) of the region where the storage pool will be created.
state string	Should the resource be present or absent. Choices: "present" ← (default) "absent"

Examples

- name: Create a storage pool
  kowabunga.cloud.pool:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: pool-01
    pool: ceph-pool
    agents:
      - my-agent
    region: eu-west-1

- name: Delete a storage pool
  kowabunga.cloud.pool:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: pool-01
    region: eu-west-1
    state: absent

Return Values

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

Key	Description
pool dictionary	Dictionary describing the storage pool. Returned: On success when state is present.
agents list / elements=string	List of agent IDs Returned: success Sample: ["6850281677f2462b6919dbe6"]
ceph_address string	Ceph cluster address Returned: success Sample: "localhost"
ceph_port integer	Ceph cluster port Returned: success Sample: 3300
description string	Storage pool description Returned: success Sample: "Storage pool 01"
id string	Storage pool ID Returned: success Sample: "6850281677f2462b6919dbe5"
name string	Storage pool name Returned: success Sample: "pool-01"
pool string	Ceph pool name Returned: success Sample: "ceph-pool"

Authors

• The Kowabunga Project

Collection links

• Repository (Sources)