Ansible module for Waldur

Waldur-based solutions can be managed with Ansible modules to allow provisioning and management of infrastructure under Waldur through Ansible playbooks.

Supported functionality

OpenStack management.
SLURM HPC management
Common client for Waldur APIs in Python.

Installation

pip install ansible-waldur-module

Example usage

Configure an Ansible playbook with parameters

  name: Trigger master instance
  waldur_marketplace_os_instance:
    access_token: "{{ access_token }}"
    api_url: "{{ api_url }}"
    flavor: m1.micro
    floating_ip: auto
    image: CentOS 7 x86_64
    name: "{{ instance_name }}"
    project: "OpenStack Project"
    offering: Instance in Tenant
    ssh_key: ssh1.pub
    subnet: vpc-1-tm-sub-net-2
    system_volume_size: 40
    wait: false

Pass parameters to an Ansible playbook

ANSIBLE_LIBRARY=/usr/share/ansible-waldur/ ansible \
    -m waldur_marketplace_os_instance \
    -a "api_url=https://waldur.example.com/api/ access_token=9036194e1ac54cada3248a8c6b203bf7 name=instance-name project='Project name'" \
    localhost

Running playbook using virtual Python environment

If you've installed Ansible Waldur module to virtual Python environment you need to specify path to Python interpreter and path to module library along with path to playbook:

ansible-playbook \
    -e ansible_python_interpreter=/home/user/ansible-env/bin/python \
    -M /home/user/ansible-env/lib/python3.8/site-packages/ \
    playbook.yml

Contributing

See general guidelines: https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html

Install pre-commit and tox

pip install tox pre-commit
pre-commit install

When new module is implemented, don't forget to update py_modules section in setup.py file.
When new module is implemented, it should be covered with tests. Run tests using tox
```
tox
```
Module name should consist of three parts separated by underscore: waldur, plugin name, entity name. For example, waldur_os_snapshot refers to OpenStack (OS) as plugin name and snapshot as entity name.

Metadata

Release files for ansible-waldur-module 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansible-waldur-module 1.2.1
File	Size	Uploaded
ansible_waldur_module-1.2.1.tar.gz	15.4 kB	Mar 4, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for ansible-waldur-module 1.2.1
File	Interpreter	ABI	Platform	Reset
ansible_waldur_module-1.2.1-py3-none-any.whl 27.9 kB Mar 4, 2025	Python 3	none	any	Details

Total release size: 43.2 kB

Release files / ansible_waldur_module-1.2.1.tar.gz

Download URL	ansible_waldur_module-1.2.1.tar.gz
Size	15.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`785c491ccfd66076747a6e19f73091983e81262ca23ef18dddf69782dde0abe0`
BLAKE2b-256 checksum How to use checksums	`1b2ae87fcd00a3ec5ee6762b0c332153fcde21cfeccd9aabf71fe15b3a30ac58`
Upload date	Mar 4, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.1.1 CPython/3.9.21 Linux/5.15.0-133-generic`

Release files / ansible_waldur_module-1.2.1-py3-none-any.whl

Download URL	ansible_waldur_module-1.2.1-py3-none-any.whl
Size	27.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`e94b3d81dae1b91c3a1d3df0bdff58a313b38ad4b88b10794ad5e938db0869d0`
BLAKE2b-256 checksum How to use checksums	`5a6ecf30f5bf6afd070558da163706c52ee27a4ba7a76225a52f517913cfbbf5`
Upload date	Mar 4, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/2.1.1 CPython/3.9.21 Linux/5.15.0-133-generic`