kowabunga.cloud.kompute module – Manage Kowabunga virtual machines

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

Synopsis

  • Create, update or delete a Kowabunga Kompute virtual machine.

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.

data_disk

integer

Data disk size in gigabytes (0 means no data disk).

Default: 0

description

string

Description for the kompute instance.

disk

integer / required

OS disk size in gigabytes.

This attribute cannot be updated.

endpoint

string / required

HTTPS(S) URI of the Kowabunga Kahuna endpoint. Should be formatted as https://kowabunga.acme.com for example.

memory

integer / required

Memory in megabytes.

This attribute cannot be updated.

name

string / required

Name for the kompute instance.

This attribute cannot be updated.

project

string / required

Name (or ID) of the project where the kompute will be created.

state

string

Should the resource be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

vcpus

integer / required

Number of virtual CPUs.

This attribute cannot be updated.

zone

string / required

Name (or ID) of the availability zone where the kompute will be created.

Examples

- name: Create a kompute instance
  kowabunga.cloud.kompute:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: vm-01
    memory: 2048
    vcpus: 2
    disk: 20
    project: my-project
    zone: eu-west-1a

- name: Delete a kompute instance
  kowabunga.cloud.kompute:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: vm-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

kompute

dictionary

Dictionary describing the kompute instance.

Returned: On success when state is present.

data_disk

integer

Data disk size in GB

Returned: success

Sample: 0

description

string

Kompute description

Returned: success

Sample: "VM 01"

disk

integer

OS disk size in GB

Returned: success

Sample: 20

id

string

Kompute ID

Returned: success

Sample: "6850281677f2462b6919dbe5"

ip

string

Assigned IP address

Returned: success

Sample: "192.168.1.10"

memory

integer

Memory in MB

Returned: success

Sample: 2048

name

string

Kompute name

Returned: success

Sample: "vm-01"

vcpus

integer

Number of virtual CPUs

Returned: success

Sample: 2

Authors

  • The Kowabunga Project