community.libvirt Collection

This repo hosts the community.libvirt Ansible Collection.

The collection includes the libvirt modules and plugins supported by Ansible libvirt community to help the management of virtual machines and/or containers via the libvirt API.

Tested with Ansible

TBD

External requirements

TBD

Supported connections

TBD

Included content

TBD

Using this collection

Before using the libvirt community collection, you need to install the collection with the ansible-galaxy CLI:

ansible-galaxy collection install community.libvirt

Alternatively, you can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml using the format:

collections:
- name: community.libvirt

For more information regarding using collections with Ansible, see the Ansible user guide.

Contributing to this collection

While this community is still developing its guidelines, the aspiration is to follow the following general guidelines:

• Changes should include tests and documentation where appropriate.
• Changes will be lint tested using standard python lint tests.
• No changes which do not pass CI testing will be approved/merged.
• The collection plugins must provide the same coverage of python support as the versions of Ansible supported.
• The versions of Ansible supported by the collection must be the same as those in developed, or those maintained, as shown in the Ansible Release and Maintenance documentation.

As a fallback, the Ansible Community Guide remains our community reference set of guidelines.

Local Testing

If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured COLLECTIONS_PATHS and work on it there.

Testing with ansible-test

TBD

Publishing New Version

TBD

More Information

Communication

This is a small collection with a small number of contributors. As such, there is no formal Ansible Working Group. To communicate with the maintainers, please make contact via one of the following methods:

• IRC on Freenode in #ansible-community
• Issues on Github

Reference

• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

License

GNU General Public License v3.0 or later.

See LICENCE to see the full text.